Skip to content

Commit 9666c0d

Browse files
authored
[DOC] Improve the release how-to (#193)
Include feedback collected during the v0.3.1 release.
1 parent 6be1b59 commit 9666c0d

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

MAINTAINERS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ ___
155155

156156
- Open the draft release note in [GitHub releases](https://github.com/process-analytics/bpmn-visualization-R/releases)
157157
- In the release description (check previous releases as a source of inspiration)
158-
- 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).`
158+
- If the bpmn-visualization TypeScript library was updated, add a phrase about it (for example, see [Release 0.3.0](https://github.com/process-analytics/bpmn-visualization-R/releases/tag/v0.3.0) for instance.): `The bpmnVisualizationR package now uses [bpmn-visualization@0.29.0](https://github.com/process-analytics/bpmn-visualization-js/releases/tag/v0.29.0).`
159159
- Put screenshots/gif of the new features.
160160
- 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.
161161
- At any time, you can save the draft.
@@ -181,9 +181,10 @@ It conforms to [the CRAN Submission policies first](https://cran.r-project.org/w
181181

182182
- Open [GitHub Actions](https://github.com/process-analytics/bpmn-visualization-R/actions/workflows/R-CMD-check.yaml)
183183
- Find the execution related to the newly created tag
184-
- If it doesn't exist, click on the 'Run workflow' dropdown located on the right side of the page
185184
- Choose the **tag that has just been created**, do not use the main branch!
186-
- Click on the button 'Run workflow'
185+
- If it doesn't exist, click on the 'Run workflow' dropdown located on the right side of the page
186+
- Remember to choose the tag that has just been created, **do not use the main branch!**
187+
- Click on the button 'Run workflow' and wait for the end of the execution
187188
- Download the source package
188189
- in the artifact section, choose the source package built with the `r-release` version, as shown in the screenshot below 👇
189190
- unzip the artifact to retrieve the tar.gz file that will submit be later

0 commit comments

Comments
 (0)