diff --git a/.Rbuildignore b/.Rbuildignore index 2d0f97e..041a8bd 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ ^_pkgdown\.yml$ ^docs$ ^pkgdown$ +^cran-comments\.md$ diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 43127cc..fb65900 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -50,12 +50,14 @@ jobs: CURRENT_VERSION=$(grep Version DESCRIPTION | sed 's/Version: \(.*\).9000/\1/g') sed -i -E "s/$CURRENT_VERSION/${{ steps.release_version.outputs.version }}/g" index.md sed -i -E "s/$CURRENT_VERSION/${{ steps.release_version.outputs.version }}/g" README.md + sed -i -E "s/$CURRENT_VERSION/${{ steps.release_version.outputs.version }}/g" cran-comments.md sed -i -E 's/Version: .*/Version: ${{ steps.release_version.outputs.version }}/g' DESCRIPTION - name: Commit with the release version run: | git add index.md git add README.md + git add cran-comments.md git add DESCRIPTION git commit -m "[RELEASE] Set the release version to ${{ steps.release_version.outputs.version }}" git push diff --git a/DESCRIPTION b/DESCRIPTION index e6d92c7..a05aa53 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,10 +7,9 @@ Authors@R: c(person("Celine", "Souchet", role = c("aut", "cre"), email = "proces Description: To visualize the execution data of the processes on BPMN (Business Process Model and Notation) diagrams, using overlays, style customization and interactions, with the bpmn-visualization TypeScript library. License: Apache License (== 2) Copyright: Bonitasoft S.A. -URL: https://process-analytics.github.io/bpmn-visualization-R, https://github.com/process-analytics/bpmn-visualization-R -BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues +URL: https://process-analytics.github.io/bpmn-visualization-R/, https://github.com/process-analytics/bpmn-visualization-R/ +BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues/ Encoding: UTF-8 -LazyData: true RoxygenNote: 7.2.3 Imports: htmlwidgets, @@ -18,5 +17,7 @@ Imports: xml2 Suggests: shiny, + spelling, testthat (>= 3.0.0) Config/testthat/edition: 3 +Language: en-US diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 2573c82..57e5749 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -16,6 +16,73 @@ A PR can only be merged into master by a maintainer, if all of these conditions Maintainers need to perform the following actions **in the order described here** to push out a release. +### Preparing a CRAN submission with `rhub` + +Before starting a release, check that the output of `rhub` package is stored in [cran-comments.md](cran-comments.md) (the recent output is at the top of the file, and the oldest at the bottom). +If this is not the case, you must perform the following steps. + +#### First installation +```R +install.packages("rhub") +library(rhub) +``` + +For the email address of the maintainer (described in [DESCRIPTION](DESCRIPTION)), `rhub` will prompt you to generate a token (on the first check), or you can [reuse one](https://r-hub.github.io/rhub/reference/validate_email.html). + +#### Check +Follow this procedure: https://r-hub.github.io/rhub/articles/rhub.html#prepare-a-cran-submission. + +```R +cran_prep <- check_for_cran() +``` + +⚠️ Locally, you can only see one run of the environment. +To see the other one, you can get the URLs from the top of the local run, and open it on a browser. + +Example: +```R +─ Preparing build, see status at +https://builder.r-hub.io/status/bpmnVisualizationR_X.Y.Z.tar.gz-A +https://builder.r-hub.io/status/bpmnVisualizationR_X.Y.Z.tar.gz-B +https://builder.r-hub.io/status/bpmnVisualizationR_X.Y.Z.tar.gz-C +``` + +#### Post processing +In [cran-comments.md](cran-comments.md): +- At the top, add this template: +```mdxjs +# bpmnVisualizationR .9000 + +This is a . In this version, we have: + +* + +## Test environments + + +## R CMD check results + + +## Response to CRAN for last submission + +> +``` +- Choose if this is a `re-submission` or a `new submission`. +- Add the new change of this version. +- Copy and paste the output of the following command, after receiving the emails for all environments on the maintainer's [email address](DESCRIPTION) from `check_for_cran()`: +```R +cran_prep$cran_summary() +``` +- Remove all `Version contains large components (X.Y.Z.9000)"` +- If this is a `re-submission`, copy and paste the result for the last CRAN submission, and answer to false NOTES. +Otherwise, remove the part: +```mdxjs +## Response to CRAN for last submission + +> +``` + + ### GitHub issues and milestones update **Note:** we always put issues related to a version in a Milestone whose name matches the version. diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..855604d --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,51 @@ +# bpmnVisualizationR 0.3.0.9000 + +This is a re-submission. In this version, we have: + +* Corrected the URLs and removed the `LazyData` field in the [DESCRIPTION](DESCRIPTION) file. +* Added a new file ([WORDLIST](inst/WORDLIST)) to allow custom words with `spelling` package. + + +## Test environments +- R-hub windows-x86_64-devel (r-devel) +- R-hub ubuntu-gcc-release (r-release) +- R-hub fedora-clang-devel (r-devel) + +## R CMD check results +❯ On ubuntu-gcc-release (r-release) + checking CRAN incoming feasibility ... NOTE + Maintainer: ‘Celine Souchet ’ + + New submission + + Possibly misspelled words in DESCRIPTION: + bpmn (7:182) + BPMN (3:44, 7:66) + TypeScript (7:201) + +❯ On fedora-clang-devel (r-devel) + checking CRAN incoming feasibility ... [5s/16s] NOTE + Maintainer: ‘Celine Souchet ’ + + New submission + + Possibly misspelled words in DESCRIPTION: + BPMN (3:44, 7:66) + TypeScript (7:201) + bpmn (7:182) + +❯ On fedora-clang-devel (r-devel) + checking HTML version of manual ... NOTE + Skipping checking HTML validation: no command 'tidy' found + +0 errors ✔ | 0 warnings ✔ | 3 notes ✖ + +## Response to CRAN for last submission + +> Possibly misspelled words in DESCRIPTION: +> BPMN (3:44, 7:66) +> TypeScript (7:201) +> bpmn (7:182) + + +These words are spelled correctly. They have been added to the [WORDLIST](inst/WORDLIST) file. \ No newline at end of file diff --git a/inst/WORDLIST b/inst/WORDLIST new file mode 100644 index 0000000..f21d81d --- /dev/null +++ b/inst/WORDLIST @@ -0,0 +1,12 @@ +BPMN +Bonitasoft +CMD +Devtools +Rmd +TypeScript +bpmn +css +devtools +htmlwidgets +widget's +️ diff --git a/man/bpmnVisualizationR-package.Rd b/man/bpmnVisualizationR-package.Rd index a082cf0..6c9559d 100644 --- a/man/bpmnVisualizationR-package.Rd +++ b/man/bpmnVisualizationR-package.Rd @@ -11,9 +11,9 @@ To visualize the execution data of the processes on BPMN (Business Process Model \seealso{ Useful links: \itemize{ - \item \url{https://process-analytics.github.io/bpmn-visualization-R} - \item \url{https://github.com/process-analytics/bpmn-visualization-R} - \item Report bugs at \url{https://github.com/process-analytics/bpmn-visualization-R/issues} + \item \url{https://process-analytics.github.io/bpmn-visualization-R/} + \item \url{https://github.com/process-analytics/bpmn-visualization-R/} + \item Report bugs at \url{https://github.com/process-analytics/bpmn-visualization-R/issues/} } } diff --git a/tests/spelling.R b/tests/spelling.R new file mode 100644 index 0000000..6713838 --- /dev/null +++ b/tests/spelling.R @@ -0,0 +1,3 @@ +if(requireNamespace('spelling', quietly = TRUE)) + spelling::spell_check_test(vignettes = TRUE, error = FALSE, + skip_on_cran = TRUE)