ci: Add CI workflow ensuring PR titles conform to Conventional Commit format #4891
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agrski
changed the title
agrski
changed the title
sakoush
reviewed
Jun 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds a check for PR titles to ensure that they are compatible with the Conventional Commit format. This imposes minimal burden to contributors: they need to specify the type of change, whether or not it is a breaking change, and optionally its scope.
This has a couple of benefits, both for human users and automation. For maintainers, it is easier to quickly grok the scope and impact of changes due to the additional context. Using tools like grep, it is also easy to filter for particular types of changes. We could consider using the CC format in release notes in the future, such that changes are automatically grouped into sections, e.g. new features, bug fixes, and breaking changes.
Which issue(s) this PR fixes:
N/A
Special notes for your reviewer:
The PR check can be seen working on this PR. Initially it will fail as I have deliberately not met the CC format for the title. After changing this, the check should pass.