Skip to content

Commit 3ec5c02

Browse files
authored
[DOC] Improve the release process steps (#152)
Note: improvements based on feedback collected during the v0.2.2 release. - remove reference to a closed issue that is completed - manual release: add the "git tag" step - CRAN submission: better explain how to fill out the form
1 parent 44ebc4a commit 3ec5c02

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

MAINTAINERS.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@ Check that the files are using the version to be released:
6161
Create a new PR (it must have the `skip-changelog` label as we don't want it to appear in the release notes) and merge it,
6262
if some files require changes. The PR/commit message should be `[RELEASE] Set version to x.y.z`.
6363

64+
Once this is done, tag manually with the following command (**do not forget** to replace `x.y.z` by the actual version):
65+
```
66+
git tag -a vx.y.z -m "[RELEASE] x.y.z"
67+
git push && git push --tags
68+
```
69+
6470
#### Use a development version
6571

6672
Add the `.9000` suffix to the `Version` field in the [DESCRIPTION](./DESCRIPTION) file to indicate that this is a development version (for more explanations, see the [R documentation](https://r-pkgs.org/release.html#post-release)).
@@ -86,7 +92,6 @@ ___
8692

8793
**NOTES**:
8894
- CRAN publishing is `in-progress`, see [#10](https://github.com/process-analytics/bpmn-visualization-R/issues/10)
89-
- This is a very manual process today. For improvements, see [#11](https://github.com/process-analytics/bpmn-visualization-R/issues/11)
9095

9196
#### Generate and retrieve the source package
9297

@@ -107,6 +112,8 @@ It conforms to [the CRAN Submission policies first](https://cran.r-project.org/w
107112
#### Do the submission
108113

109114
- Fill all the fields of this [web form](https://xmpalantir.wu.ac.at/cransubmit/), and load `bpmnVisualization_X.Y.Z.tgz` file.
115+
- upload the package `tar.gz` source previously retrieved
116+
- 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)
110117
- Submit
111118

112119
## Communicate about the release

0 commit comments

Comments
 (0)