Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] improve the release description in the Contributing guide #554

Merged
merged 4 commits into from
Aug 27, 2020
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,17 +296,34 @@ You must create a Pull Request to integrate any changes to this repository.
#### Demo environment update
Make the new version available for demo

- build it locally
- the `Upload` GitHub workflow has built the demo for the new tag, so download the demo artifact directly from the
Actions section on GitHub
- alternatively, if the artifact is not available via GitHub Actions, you can build it locally
- checkout the git tag related to the new version
- run `npm run demo` which generates it in the `dist` folder
- alternatively, as the GitHub workflow building the demo should have run on the tag, you can download the demo artifact
associated to the run workflow
- push the demo resources to the demo folder of the [bpmn-visualization-examples](https://github.com/process-analytics/bpmn-visualization-examples/demo)
repository (proceed how it has been done for prior versions).
- create a new branch in the [bpmn-visualization-examples](https://github.com/process-analytics/bpmn-visualization-examples/demo)
repository and add the new demo content (proceed how it has been done for prior versions).
- push to GitHub and create a new Pull Request

#### Examples update
If possible, make the examples use the latest version of the lib.
**Note**: do this using the Pull Request you have just created for the demo update

Make the examples use the latest version of the lib. A bash script is available to help you for this task in the `scripts`
folder.
Tests that the examples work with the new lib version.


#### Tagging
When all updates have been completed, tag the repository with the same tag as the lib.
When all updates have been completed, merge the Pull Request created above.


To create the tag, the easiest way is to create a new release by following the [GitHub help](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)
- for `Tag version`, use a value that is the same as the lib. The tag will be created when the release will be published
- for `Target`
- usually, keep the `master` branch except if new commits that you don't want to integrate for the release are already
available in the branch
- in that case, choose a dedicated commit
- **important**: ensure that the build to pass on the chosen branch or commit used to create the release
aibcmars marked this conversation as resolved.
Show resolved Hide resolved


Alternatively, you can create the tag from your local machine and then push it.