Skip to content

Commit

Permalink
docs(contributors): explain the usage of PR labels (#3269)
Browse files Browse the repository at this point in the history
Co-authored-by: Souchet Céline <[email protected]>
  • Loading branch information
tbouffard and csouchet authored Feb 3, 2025
1 parent f31b909 commit acab3de
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/contributors/maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
A Pull Request (referred as PR in the rest of this documentation) should only be merged into the `master` branch by a maintainer, if all
of these conditions are met:
- All Checks are green.
- It has been approved by at least two maintainers. If it was a maintainer who opened the PR, only one approval is needed.
- It has at least two maintainer approvals (one if it was opened by a maintainer).
- It has no requested changes.
- It is up-to-date with the `master` branch.
- Labels are correctly set for auto-generated release notes.

## Release process

Expand Down Expand Up @@ -36,6 +37,14 @@ are automated once the release is triggered but manual actions are required for:
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 GitHub release includes an auto-generated release notes based on merged PR labels. To ensure this works:
- Label all merged PRs in the release. Check [unlabeled PRs](https://github.com/process-analytics/bpmn-visualization-js/pulls?q=is%3Apr+sort%3Aupdated-desc+no%3Alabel+is%3Amerged) to add missing labels.
- Ensure that all PRs related to bump production dependencies (e.g., mxGraph) do not have the `skip-changelog` label. Otherwise, they are not included in the changelog.
Find such PRs here: [bump prod dependency PR with skip-changelog label](https://github.com/process-analytics/bpmn-visualization-js/pulls?q=is%3Apr+is%3Amerged+%22chore%28deps%29%22+in%3Atitle+NOT+%22chore%28deps-dev%29%22+in%3Atitle+label%3Askip-changelog+).

**Note**: Currently, dependabot can't apply different labels to production and development dependency update PRs, so labels must be checked manually.
For more details, see the [dependabot labels documentation](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#labels--).

#### Set the release version and create a git tag

**Note:** This step triggers the release automation process.
Expand Down

0 comments on commit acab3de

Please sign in to comment.