chore: Enforce conventional commit PR title #3083
Merged
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
This was referenced Nov 13, 2022
mxinden
approved these changes
Nov 14, 2022
elenaf9
reviewed
Nov 14, 2022
Co-authored-by: Elena Frank <elena.frank@protonmail.com>
thomaseizinger
commented
Nov 15, 2022
4 tasks
mxinden
added a commit
that referenced
this pull request
Nov 24, 2022
4 tasks
mergify bot
pushed a commit
that referenced
this pull request
Dec 13, 2022
…#3204) As per decision in #3083, we want to use the conventional commits in our repository. To make sure this actually happens, this patch adds a workflow that validates PR titles to follow this convention. Together with our mergify configuration, these PR titles end up being the commit message title when squash-merging a pull request. Related: #3083 Related: libp2p/github-mgmt#93
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.
Description
Forces PR titles to follow the "conventional commit" specification.
Currently, mergify will set the PR title as the commit message when squashing:
rust-libp2p/.github/mergify.yml
Line 6 in f9b4af3
Based on the commit message, we can use tools like
release-pleaseto automatically generate changelogs and bump versions. Enforcing those rules brings us one step closer to that.I choose the following set of prefixes:
fix: A bugfix, resulting in a semver patch bumpfeat: A feature, resulting in a semver minor bumpdeps: Dependabot updatesOnly these represent "releasable units" for
release-please.refactor: Useful to indicate that a PR is a pure refactoring and should not change functionalitydocs: Documentation update onlychore: Anything elseFixes #3054.
Links to any relevant issues
Open Questions
Change checklist