You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[DOC] Warn users for releases not available on CRAN (#178)
Update the maintainers documentation to remind writers to notify users through the release notes. In this case, the new version of the package will be install using GitHub.
Copy file name to clipboardExpand all lines: MAINTAINERS.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,8 @@ ___
83
83
- Open the draft release note in [GitHub releases](https://github.com/process-analytics/bpmn-visualization-R/releases)
84
84
- In the release description (check previous releases as a source of inspiration)
85
85
- If the bpmn-visualization TypeScript library was updated, add a phrase about it (see [Release 0.2.1](https://github.com/process-analytics/bpmn-visualization-R/releases/tag/v0.2.1) for instance.): `The R package now uses [bpmn-visualization@0.26.2](https://github.com/process-analytics/bpmn-visualization-js/releases/tag/v0.26.2).`
86
-
- put screenshots/gif of the new features.
86
+
- Put screenshots/gif of the new features.
87
+
- If the package will not be published on CRAN (see below), please specify it by adding a sentence in bold! The sentence should explain why the new version is not available on CRAN and remind to install it using GitHub.
87
88
- At any time, you can save the draft.
88
89
-**Only when you are done**:
89
90
- Assign the tag of the new version as release target and save the draft (doing it as later as possible ensure that `release-drafter` doesn't interfer with the writing of the Release Notes)
@@ -94,6 +95,13 @@ ___
94
95
**NOTES**:
95
96
- CRAN publishing is `in-progress`, see [#10](https://github.com/process-analytics/bpmn-visualization-R/issues/10)
96
97
98
+
#### ⚠️⚠️ First decide whether to publish on CRAN ⚠️⚠️
99
+
100
+
The CRAN policies state (see https://r-pkgs.org/release.html#cran-policies and https://cran.r-project.org/web/packages/policies.html)
101
+
> Submitting updates should be done responsibly and with respect for the volunteers’ time. Once a package is established (which may take several rounds), “no more than every 1–2 months” seems appropriate.
102
+
103
+
However, on our side, we can provide more frequent versions. In this case, do not publish no CRAN. The new version will be available only via an installation from GitHub.
104
+
97
105
#### Generate and retrieve the source package
98
106
99
107
It conforms to [the CRAN Submission policies first](https://cran.r-project.org/web/packages/policies.html#Submission)
@@ -116,10 +124,14 @@ It conforms to [the CRAN Submission policies first](https://cran.r-project.org/w
116
124
- upload the package `tar.gz` source previously retrieved
117
125
- for all required fields, use the value from the DESCRIPTION file of the `tar.gz` source (in particular, the name and email of the maintainer of the package are available at the end of the file)
118
126
- Submit
127
+
-**Don't forget to confirm the submission**:
128
+
- A few minutes after the submission, the package manager should have received an email asking to confirm the submission. The email object looks like `CRAN Submission of bpmnVisualizationR 0.3.0 - Confirmation Link`
129
+
- Confirm the submission by clicking on the link provided in the email
130
+
- The submission is only effective when a new email is received from CRAN confirming the submission. The email object looks like `CRAN Submission of bpmnVisualizationR 0.3.0`
119
131
120
132
## Communicate about the release
121
133
122
-
- Open [github actions](https://github.com/process-analytics/bpmn-visualization-R/actions/workflows/announce-new-release.yml)
134
+
- Open [GitHub Actions](https://github.com/process-analytics/bpmn-visualization-R/actions/workflows/announce-new-release.yml)
123
135
- Click on the 'Run workflow' dropdown located on the right side of the page
124
136
- Provide parameter values for _version_ and _description_
0 commit comments