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.

Sign up for GitHub

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

docs: simplify the release in the examples repository #3011

Merged
merged 2 commits into from
Jan 22, 2024
Merged

docs: simplify the release in the examples repository #3011

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1f83a9
docs: simplify the release in the examples repository
tbouffard Jan 8, 2024
842363b
Merge branch 'master' into docs/simplify_release_examples_repo
csouchet Jan 22, 2024
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
23 changes: 20 additions & 3 deletions docs/contributors/maintainers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,24 @@ For the detailed list of available examples, please check the [examples home pag
#### Mark the `bpmn-visualization-examples` repository as released
When all updates have been completed, merge the Pull Request created above.

Then create a GitHub release:
- Open [GitHub actions](https://github.com/process-analytics/bpmn-visualization-examples/actions/workflows/create-gh-release.yml)
- Click on the 'Run workflow' dropdown located on the right side of the page
- Provide parameter value for the `version` input
- Click on the button 'Run workflow'
- Make sure job execution was successful by checking the status


You should have something like in release [v0.21.2](https://github.com/process-analytics/bpmn-visualization-examples/releases/tag/v0.21.2)

![release process automation overview](./images/release_process_part-10_examples_release-notes.png)


___
⚠️⚠️⚠️ _**Only if the job to create the GitHub release does NOT work!**_ ⚠️⚠️⚠️

##### Manual procedure

Create a new GitHub 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 in the vX.Y.Z form**. The git tag will be created when the release will be published.
- for `Target`
Expand All @@ -153,9 +171,8 @@ Create a new GitHub release by following the [GitHub help](https://help.github.c
- add a link to the live environment for the related tag
- make GitHub generates the [release notes automatically](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)

You should have something like in release [v0.21.2](https://github.com/process-analytics/bpmn-visualization-examples/releases/tag/v0.21.2)

![release process automation overview](./images/release_process_part-10_examples_release-notes.png)
⚠️⚠️⚠️ _**End of the manual steps**_ ⚠️⚠️⚠️
___

___
⚠️⚠️⚠️ _**Only if the [notification](https://github.com/process-analytics/bpmn-visualization-js/actions/runs/2191000065) does NOT work!**_ ⚠️⚠️⚠️
Expand Down