chore: Add PR title validation #169
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
bgins
force-pushed
the
bgins/chore-add-pr-title-validation
branch
3 times, most recently
from
d4ea868 to
b5b31b1
Compare
AquiGorka
approved these changes
Jun 19, 2024
AquiGorka
reviewed
Jun 19, 2024
| - name: PR Conventional Commit Validation | ||
| uses: ytanikin/[email protected] | ||
| with: | ||
| task_types: '["fix","feat","refactor","spike","hotfix","revert","chore","docs","test","build"]' |
There was a problem hiding this comment.
Missing ci and perf?
I'm looking at this list: https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
There was a problem hiding this comment.
We haven't included those in our guide in Notion, but we could. IIRC, we thought ci didn't add much that build doesn't already cover, but perf could be an interesting one to add.
|
@bgins this feels like something we need to socialise so that the team are aware how to write their PR titles |
Yes absolutely! I'll give a quick presentation at engineering catchup tomorrow. |
|
thanks @bgins ! |
bgins
force-pushed
the
bgins/chore-add-pr-title-validation
branch
from
b5b31b1 to
4cc3ca4
Compare
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.
Review Type Requested (choose one):
Summary
This pull request adds a PR title validation GitHub action. The action checks that PR titles use conventional commits from a custom list matching our task types.
The GitHub action also labels PRs based on the task type. The
custom_labelsgive us longer form titles for the labels. (These labels are optional, but seem like a nice bonus feature.)This PR sets the stage for using conventional commits for semantic versioning. We want to validate before merging to
mainto determine the new release version.Task/Issue reference
Implements: #168