Skip to content

Commit ed33aec

Browse files
csouchetcsouchet
authored
[DOC] Fix CRAN submission (#184)
* Corrected the URLs and removed `LazyData` field in the DESCRIPTION file. * Added a new file `WORDLIST` to allow custom words with `spelling` package. * Updated the documentation of the maintainers to execute `rhub` package before starting a new release * Added a new file `cran-comments.md` for the CRAN submission * Updated the `release` workflow to update the last version in `cran-comments.md`
1 parent c7099d8 commit ed33aec

8 files changed

Lines changed: 143 additions & 6 deletions

File tree

‎.Rbuildignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@
99
^_pkgdown\.yml$
1010
^docs$
1111
^pkgdown$
12+
^cran-comments\.md$

‎.github/workflows/release.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,14 @@ jobs:
5050
CURRENT_VERSION=$(grep Version DESCRIPTION | sed 's/Version: \(.*\).9000/\1/g')
5151
sed -i -E "s/$CURRENT_VERSION/${{ steps.release_version.outputs.version }}/g" index.md
5252
sed -i -E "s/$CURRENT_VERSION/${{ steps.release_version.outputs.version }}/g" README.md
53+
sed -i -E "s/$CURRENT_VERSION/${{ steps.release_version.outputs.version }}/g" cran-comments.md
5354
sed -i -E 's/Version: .*/Version: ${{ steps.release_version.outputs.version }}/g' DESCRIPTION
5455
5556
- name: Commit with the release version
5657
run: |
5758
git add index.md
5859
git add README.md
60+
git add cran-comments.md
5961
git add DESCRIPTION
6062
git commit -m "[RELEASE] Set the release version to ${{ steps.release_version.outputs.version }}"
6163
git push

‎DESCRIPTION‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@ Authors@R: c(person("Celine", "Souchet", role = c("aut", "cre"), email = "proces
77
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.
88
License: Apache License (== 2)
99
Copyright: Bonitasoft S.A.
10-
URL: https://process-analytics.github.io/bpmn-visualization-R, https://github.com/process-analytics/bpmn-visualization-R
11-
BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues
10+
URL: https://process-analytics.github.io/bpmn-visualization-R/, https://github.com/process-analytics/bpmn-visualization-R/
11+
BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues/
1212
Encoding: UTF-8
13-
LazyData: true
1413
RoxygenNote: 7.2.3
1514
Imports:
1615
htmlwidgets,
1716
rlang,
1817
xml2
1918
Suggests:
2019
shiny,
20+
spelling,
2121
testthat (>= 3.0.0)
2222
Config/testthat/edition: 3
23+
Language: en-US

‎MAINTAINERS.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,73 @@ A PR can only be merged into master by a maintainer, if all of these conditions
1616

1717
Maintainers need to perform the following actions **in the order described here** to push out a release.
1818

19+
### Preparing a CRAN submission with `rhub`
20+
21+
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).
22+
If this is not the case, you must perform the following steps.
23+
24+
#### First installation
25+
```R
26+
install.packages("rhub")
27+
library(rhub)
28+
```
29+
30+
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).
31+
32+
#### Check
33+
Follow this procedure: https://r-hub.github.io/rhub/articles/rhub.html#prepare-a-cran-submission.
34+
35+
```R
36+
cran_prep <- check_for_cran()
37+
```
38+
39+
⚠️ Locally, you can only see one run of the environment.
40+
To see the other one, you can get the URLs from the top of the local run, and open it on a browser.
41+
42+
Example:
43+
```R
44+
─ Preparing build, see status at
45+
https://builder.r-hub.io/status/bpmnVisualizationR_X.Y.Z.tar.gz-A
46+
https://builder.r-hub.io/status/bpmnVisualizationR_X.Y.Z.tar.gz-B
47+
https://builder.r-hub.io/status/bpmnVisualizationR_X.Y.Z.tar.gz-C
48+
```
49+
50+
#### Post processing
51+
In [cran-comments.md](cran-comments.md):
52+
- At the top, add this template:
53+
```mdxjs
54+
# bpmnVisualizationR <X.Y.Z>.9000
55+
56+
This is a <re-submission | new submission>. In this version, we have:
57+
58+
* <NEW CHANGE>
59+
60+
## Test environments
61+
<RESULT OF check_for_cran()>
62+
63+
## R CMD check results
64+
<RESULT OF check_for_cran()>
65+
66+
## Response to CRAN for last submission
67+
68+
> <CITATION>
69+
```
70+
- Choose if this is a `re-submission` or a `new submission`.
71+
- Add the new change of this version.
72+
- 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()`:
73+
```R
74+
cran_prep$cran_summary()
75+
```
76+
- Remove all `Version contains large components (X.Y.Z.9000)"`
77+
- If this is a `re-submission`, copy and paste the result for the last CRAN submission, and answer to false NOTES.
78+
Otherwise, remove the part:
79+
```mdxjs
80+
## Response to CRAN for last submission
81+
82+
> <CITATION>
83+
```
84+
85+
1986
### GitHub issues and milestones update
2087

2188
**Note:** we always put issues related to a version in a Milestone whose name matches the version.

‎cran-comments.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# bpmnVisualizationR 0.3.0.9000
2+
3+
This is a re-submission. In this version, we have:
4+
5+
* Corrected the URLs and removed the `LazyData` field in the [DESCRIPTION](DESCRIPTION) file.
6+
* Added a new file ([WORDLIST](inst/WORDLIST)) to allow custom words with `spelling` package.
7+
8+
9+
## Test environments
10+
- R-hub windows-x86_64-devel (r-devel)
11+
- R-hub ubuntu-gcc-release (r-release)
12+
- R-hub fedora-clang-devel (r-devel)
13+
14+
## R CMD check results
15+
❯ On ubuntu-gcc-release (r-release)
16+
checking CRAN incoming feasibility ... NOTE
17+
Maintainer: ‘Celine Souchet <process.analytics.dev+CRAN@gmail.com>’
18+
19+
New submission
20+
21+
Possibly misspelled words in DESCRIPTION:
22+
bpmn (7:182)
23+
BPMN (3:44, 7:66)
24+
TypeScript (7:201)
25+
26+
❯ On fedora-clang-devel (r-devel)
27+
checking CRAN incoming feasibility ... [5s/16s] NOTE
28+
Maintainer: ‘Celine Souchet <process.analytics.dev+CRAN@gmail.com>’
29+
30+
New submission
31+
32+
Possibly misspelled words in DESCRIPTION:
33+
BPMN (3:44, 7:66)
34+
TypeScript (7:201)
35+
bpmn (7:182)
36+
37+
❯ On fedora-clang-devel (r-devel)
38+
checking HTML version of manual ... NOTE
39+
Skipping checking HTML validation: no command 'tidy' found
40+
41+
0 errors ✔ | 0 warnings ✔ | 3 notes ✖
42+
43+
## Response to CRAN for last submission
44+
45+
> Possibly misspelled words in DESCRIPTION:
46+
> BPMN (3:44, 7:66)
47+
> TypeScript (7:201)
48+
> bpmn (7:182)
49+
50+
51+
These words are spelled correctly. They have been added to the [WORDLIST](inst/WORDLIST) file.

‎inst/WORDLIST‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
BPMN
2+
Bonitasoft
3+
CMD
4+
Devtools
5+
Rmd
6+
TypeScript
7+
bpmn
8+
css
9+
devtools
10+
htmlwidgets
11+
widget's
12+
️

‎man/bpmnVisualizationR-package.Rd‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/spelling.R‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
if(requireNamespace('spelling', quietly = TRUE))
2+
spelling::spell_check_test(vignettes = TRUE, error = FALSE,
3+
skip_on_cran = TRUE)

0 commit comments

Comments
 (0)