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

[DOC] improve the release how-to #434

Merged
merged 3 commits into from
Jul 20, 2020
Merged

[DOC] improve the release how-to #434

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42e725b
[DOC] improve the release how-to
tbouffard Jul 16, 2020
a75b7ae
Merge branch 'master' into doc/contrib-guide_release_how-to_improvements
csouchet Jul 16, 2020
b2b89db
Merge branch 'master' into doc/contrib-guide_release_how-to_improvements
csouchet Jul 20, 2020
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
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ A PR can only be merged into master by a maintainer, if all of these conditions

### Release (maintainers only)

Maintainers need to do the manual following actions to push out a release.
Maintainers need to do the manual following actions **in the order described here** to push out a release.

For automation, see [#139](https://github.com/process-analytics/bpmn-visualization-js/issues/139).

Expand All @@ -262,21 +262,22 @@ of the `Done` column related to the milestone

#### GitHub update

- Ensure the latest closed milestone matches the name of the tag/version that has just been pushed. Renamed it if needed
- GitHub release
- Open [github releases](https://github.com/process-analytics/bpmn-visualization-js/releases)
- Create a new draft release and name it `Next` (the name is not relevant and will be replaced automatically later).
This ensures that development can continue without impacting the writing of the content of the in progress release. That way,
if a PR is merged, `release-drafter` will update the `Next` draft release keeping the in-progress release untouched.
- The draft release for the newly tagged version should already exist:
- [release-drafter](https://github.com/release-drafter/release-drafter) creates or updates draft release for the
next version each time a pull request is merged to the `master` branch.
- create a new release if it is missing or rename the existing one.
- Create a new draft release and name it `New`. This ensures that development can continue without impacting the
writing of the release content. That way, if a PR is merged, `release-drafter` will update the `New` draft release
keeping the in-progress release untouched.
- create a new release if it is missing or rename the existing one to match .
- Assign the new tag as release target and save the draft (this should have already been managed by `release-drafter`)
- Ensure that `This is a pre-release` is unchecked (except if we are releasing alpha, beta, rc, ...)
- In the release description (check previous releases as a source of inspiration)
- at least add/update a link to the related milestone
- put screenshots/gif of the new features
- Ensure the latest closed milestone matches the name of the tag/version that has just been pushed
- Published the release **only when you are done** with the release content. At any time, you can save the draft

### Demo environment update

Expand Down