build: Add checker for PR title #151
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
viirya
approved these changes
Mar 2, 2024
comphead
reviewed
Mar 2, 2024
| run: | | ||
| if ! echo $PR_TITLE | grep -Eq '^(\w+)(\(.+\))?: .+$'; then | ||
| echo "PR title does not follow conventional commit style." | ||
| echo "Please use a title in the format: type: message, or type(scope): message" |
There was a problem hiding this comment.
I think its misleading a bit, @sunchao
maybe we can attach a title example?
comphead
approved these changes
Mar 2, 2024
|
Thanks, merged |
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.
Which issue does this PR close?
Closes #75 .
Rationale for this change
It be useful to add a checker making sure all the PR titles conform to certain format, such as conventional commits.
What changes are included in this PR?
Added a Github action to check PR title and fail the PR if it violates the format. At the moment, the format is simply "type: message" or "type(scope): message". We don't restrict the set of valid types or scopes yet.
How are these changes tested?