ci: Workflow to check PR for conventional commit format #5528
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
- PRs will need to adhere to the conventional commit specification: https://www.conventionalcommits.org/en/v1.0.0/ - If they do not, a comment will be added to the PR with details about the spec - Follow up: - Add this check to branch protection - Use the commit history to automatically generate the changelog. In the deephaven-plugins repo, we use cocogitto, which also automatically bumps the version - Recommend to use PR_BODY and PR_TITLE for the default squash_merge_commit_mesage and squash_merge_commit_title
mofojed
added
NoDocumentationNeeded
NoReleaseNotesNeeded
mofojed
requested review from
devinrsmith,
jcferretti,
JamesXNelson and
rcaudy
as code owners
dsmmcken
reviewed
May 24, 2024
devinrsmith
approved these changes
May 29, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR_BODYandPR_TITLEfor the defaultsquash_merge_commit_mesageandsquash_merge_commit_titlerespectivelyI also noticed that with GitHub's automated release notes, you can actually configure it to use the labels to categorize PRs. That could be useful if there's hesitation to using conventional commits. One advantage of conventional commits is that you can easily handle automatic version bumping (we use cocogitto), which I don't think GitHub can do.