-
Notifications
You must be signed in to change notification settings - Fork 0
ci: enforce conventional commit PR titles #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Validate that every PR title is a Conventional Commit. | ||
| # | ||
| # We squash-merge with the PR title as the commit subject (repo setting | ||
| # squash_merge_commit_title=PR_TITLE), and release-please derives the version | ||
| # bump + changelog from that subject. So a non-conventional PR title would | ||
| # silently break versioning — this check is the guard. | ||
| # | ||
| # pull_request_target is used (not pull_request) so the check still runs for | ||
| # fork PRs; it only reads the title via the API and never checks out PR code, | ||
| # so there is no untrusted-code execution risk. | ||
| name: pr-title | ||
|
|
||
| on: | ||
| pull_request_target: | ||
| types: [opened, edited, reopened, synchronize] | ||
|
|
||
| permissions: | ||
| pull-requests: read | ||
|
|
||
| concurrency: | ||
| group: pr-title-${{ github.event.pull_request.number }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| validate: | ||
| name: conventional PR title | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: amannn/action-semantic-pull-request@v6.1.1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| # Keep in sync with release-please's understanding of types. | ||
| types: | | ||
| feat | ||
| fix | ||
| docs | ||
| chore | ||
| ci | ||
| refactor | ||
| perf | ||
| test | ||
| build | ||
| revert | ||
| # Subject must not be empty and not start with an uppercase letter. | ||
| subjectPattern: ^(?![A-Z]).+$ | ||
| subjectPatternError: | | ||
| The subject "{subject}" must start with a lowercase letter, e.g. | ||
| "fix: correct the origin resolver", not "fix: Correct ...". | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.