From 040c735ca589b652df7e4b05665cd7d80bc323c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 10 Jan 2023 11:34:33 +0100 Subject: [PATCH 01/11] Fix urls --- DESCRIPTION | 4 ++-- man/bpmnVisualizationR-package.Rd | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index e6d92c7..5d7bc84 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,8 +7,8 @@ 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 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/} } } From 583a3bbc57b49bb29d51ba317d6be97790bd5790 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 10 Jan 2023 14:14:21 +0100 Subject: [PATCH 02/11] Run usethis::use_spell_check() --- DESCRIPTION | 2 ++ inst/WORDLIST | 12 ++++++++++++ tests/spelling.R | 3 +++ 3 files changed, 17 insertions(+) create mode 100644 inst/WORDLIST create mode 100644 tests/spelling.R diff --git a/DESCRIPTION b/DESCRIPTION index 5d7bc84..0e56988 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -18,5 +18,7 @@ Imports: xml2 Suggests: shiny, + spelling, testthat (>= 3.0.0) Config/testthat/edition: 3 +Language: en-US 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/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) From c4c91df027e911be2b3a106c54f304b810471868 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 10 Jan 2023 14:14:43 +0100 Subject: [PATCH 03/11] Add cran-comments.md --- .Rbuildignore | 1 + cran-comments.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 cran-comments.md 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/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..6630116 --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,17 @@ +# Release summary + +This is a resubmission. In this version, I have: + +* Fixed the URLs in the DESCRIPTION file. +* Added a new file ([WORDLIST](inst%2FWORDLIST)) to allow custom words + +## R CMD check results + +0 errors | 0 warnings | 0 note + +## Possibly misspelled words in DESCRIPTION from the last submission + BPMN (3:44, 7:66) + TypeScript (7:201) + bpmn (7:182) + +These words are spelled correctly. They have been added to the [WORDLIST](inst%2FWORDLIST) file. \ No newline at end of file From 8bd7add8e0da368146d102c1ebfd74bfb64dfbec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 10 Jan 2023 17:51:14 +0100 Subject: [PATCH 04/11] Remove LazyData from DESCRIPTION file to avoid the following note: "'LazyData' is specified without a 'data' directory" --- DESCRIPTION | 1 - 1 file changed, 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 0e56988..a05aa53 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,7 +10,6 @@ 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/ Encoding: UTF-8 -LazyData: true RoxygenNote: 7.2.3 Imports: htmlwidgets, From 6290220e757381950572b8477730593b5dcb2805 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 10 Jan 2023 18:05:49 +0100 Subject: [PATCH 05/11] Update cran-comments.md --- cran-comments.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/cran-comments.md b/cran-comments.md index 6630116..f2afb27 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,17 +1,24 @@ -# Release summary +# bpmnVisualizationR 0.3.0.9000 -This is a resubmission. In this version, I have: +This is a resubmission. In this version, we have: * Fixed the URLs in the DESCRIPTION file. * Added a new file ([WORDLIST](inst%2FWORDLIST)) to allow custom words + +## Test environments + + ## R CMD check results 0 errors | 0 warnings | 0 note -## Possibly misspelled words in DESCRIPTION from the last submission - BPMN (3:44, 7:66) - TypeScript (7:201) - bpmn (7:182) +## Reply from CRAN for the 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%2FWORDLIST) file. \ No newline at end of file From 76b6253f9799e7b0b7c44b92e6c09cee94e51f53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 10 Jan 2023 18:08:59 +0100 Subject: [PATCH 06/11] Update the release workflow --- .github/workflows/release.yml | 2 ++ 1 file changed, 2 insertions(+) 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 From 10726c7d265d16d794a7b5d910f2df346551754f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 10 Jan 2023 18:16:55 +0100 Subject: [PATCH 07/11] Update the maintainer documentation --- MAINTAINERS.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 2573c82..9560c31 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. +### Prepare a CRAN submission with `rhub` + +Before starting a release, verify that the result of `rhub` package is stored in [cran-comments.md](cran-comments.md) (the recent result is on top of the file, and the oldest on the bottom). +If not, you need to do the next steps. + +#### First installation +```R +install.packages("rhub") +library(rhub) +``` + +For the email address of the maintainer (described on [DESCRIPTION](DESCRIPTION)), `rhub` will ask 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() +``` + +⚠️ In local, you can only see one environment execution. +To see the other, you can get the URLs from the top of the local execution, 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 traitement +In [cran-comments.md](cran-comments.md): +- On the top, add this template: +```mdxjs +# bpmnVisualizationR .9000 + +This is a . In this version, we have: + +* + +## Test environments + + +## R CMD check results + + +## Reply from CRAN for the last submission + +> +``` +- Choose if it is a `resubmission` or a `new submission`. +- Add the new change of this release. +- Copy-paste the result of the following command, after receiving the emails for all environments on the [email address](DESCRIPTION) of the maintainer from `check_for_cran()`: +```R +cran_prep$cran_summary() +``` +- Remove all `Version contains large components (X.Y.Z.9000)"` +- If it is a `resubmission`, copy-paste the result for the last CRAN submission, and reply to false NOTES. +If not, remove the part: +```mdxjs +## Reply from CRAN for the last submission + +> +``` + + ### GitHub issues and milestones update **Note:** we always put issues related to a version in a Milestone whose name matches the version. From 1d54c677c270c8c4fdc7e61e9c444649ecd676f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Wed, 11 Jan 2023 11:48:05 +0100 Subject: [PATCH 08/11] Update cran-comments.md --- cran-comments.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/cran-comments.md b/cran-comments.md index f2afb27..ba1f50a 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -3,15 +3,42 @@ This is a resubmission. In this version, we have: * Fixed the URLs in the DESCRIPTION file. -* Added a new file ([WORDLIST](inst%2FWORDLIST)) to allow custom words +* Added a new file ([WORDLIST](inst/WORDLIST)) to allow custom words ## 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 - -0 errors | 0 warnings | 0 note +❯ 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 ✖ ## Reply from CRAN for the last submission @@ -21,4 +48,4 @@ This is a resubmission. In this version, we have: > bpmn (7:182) -These words are spelled correctly. They have been added to the [WORDLIST](inst%2FWORDLIST) file. \ No newline at end of file +These words are spelled correctly. They have been added to the [WORDLIST](inst/WORDLIST) file. \ No newline at end of file From 1e5bbc2c757c252749889d80e6eb3a94ec0b8da4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Wed, 11 Jan 2023 15:58:24 +0100 Subject: [PATCH 09/11] Fix english --- MAINTAINERS.md | 32 ++++++++++++++++---------------- cran-comments.md | 8 ++++---- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 9560c31..57e5749 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -16,10 +16,10 @@ 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. -### Prepare a CRAN submission with `rhub` +### Preparing a CRAN submission with `rhub` -Before starting a release, verify that the result of `rhub` package is stored in [cran-comments.md](cran-comments.md) (the recent result is on top of the file, and the oldest on the bottom). -If not, you need to do the next steps. +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 @@ -27,7 +27,7 @@ install.packages("rhub") library(rhub) ``` -For the email address of the maintainer (described on [DESCRIPTION](DESCRIPTION)), `rhub` will ask you to generate a token (on the first check), or you can [reuse one](https://r-hub.github.io/rhub/reference/validate_email.html). +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. @@ -36,8 +36,8 @@ Follow this procedure: https://r-hub.github.io/rhub/articles/rhub.html#prepare-a cran_prep <- check_for_cran() ``` -⚠️ In local, you can only see one environment execution. -To see the other, you can get the URLs from the top of the local execution, and open it on a browser. +⚠️ 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 @@ -47,13 +47,13 @@ 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 traitement +#### Post processing In [cran-comments.md](cran-comments.md): -- On the top, add this template: +- At the top, add this template: ```mdxjs # bpmnVisualizationR .9000 -This is a . In this version, we have: +This is a . In this version, we have: * @@ -63,21 +63,21 @@ This is a . In this version, we have: ## R CMD check results -## Reply from CRAN for the last submission +## Response to CRAN for last submission > ``` -- Choose if it is a `resubmission` or a `new submission`. -- Add the new change of this release. -- Copy-paste the result of the following command, after receiving the emails for all environments on the [email address](DESCRIPTION) of the maintainer from `check_for_cran()`: +- 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 it is a `resubmission`, copy-paste the result for the last CRAN submission, and reply to false NOTES. -If not, remove the part: +- 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 -## Reply from CRAN for the last submission +## Response to CRAN for last submission > ``` diff --git a/cran-comments.md b/cran-comments.md index ba1f50a..7617cbe 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,9 +1,9 @@ # bpmnVisualizationR 0.3.0.9000 -This is a resubmission. In this version, we have: +This is a re-submission. In this version, we have: -* Fixed the URLs in the DESCRIPTION file. -* Added a new file ([WORDLIST](inst/WORDLIST)) to allow custom words +* Corrected the URLs in the DESCRIPTION file. +* Added a new file ([WORDLIST](inst/WORDLIST)) to allow custom words. ## Test environments @@ -40,7 +40,7 @@ This is a resubmission. In this version, we have: 0 errors ✔ | 0 warnings ✔ | 3 notes ✖ -## Reply from CRAN for the last submission +## Response to CRAN for last submission > Possibly misspelled words in DESCRIPTION: > BPMN (3:44, 7:66) From 99dc0f81b7f228540709d51219c95fca6a2fbb47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Wed, 11 Jan 2023 16:31:50 +0100 Subject: [PATCH 10/11] Add missing change in cran-comments.md --- cran-comments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cran-comments.md b/cran-comments.md index 7617cbe..14cc2be 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -2,7 +2,7 @@ This is a re-submission. In this version, we have: -* Corrected the URLs in the DESCRIPTION file. +* Corrected the URLs and removed the `LazyData` field in the [DESCRIPTION](DESCRIPTION) file. * Added a new file ([WORDLIST](inst/WORDLIST)) to allow custom words. From b5f689e860a700247db1194bd54248114518bba2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Wed, 11 Jan 2023 16:33:32 +0100 Subject: [PATCH 11/11] Update change in cran-comments.md --- cran-comments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cran-comments.md b/cran-comments.md index 14cc2be..855604d 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -3,7 +3,7 @@ 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. +* Added a new file ([WORDLIST](inst/WORDLIST)) to allow custom words with `spelling` package. ## Test environments