-
-
Notifications
You must be signed in to change notification settings - Fork 510
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(ci): enforce conventional commits syntax in PR titles (#2911)
* chore(ci): enforce conventional commits syntax in PR titles * chore: more explicit config and docs about the conventions
- Loading branch information
1 parent
0bbab5e
commit f884d5b
Showing
2 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
name: "Enforce conventions" | ||
|
||
on: | ||
pull_request_target: | ||
types: | ||
- opened | ||
- edited | ||
- synchronize | ||
- reopened | ||
|
||
permissions: | ||
pull-requests: read | ||
|
||
jobs: | ||
lint-pr: | ||
name: Validate PR title follows Conventional Commits | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
# We may not need a scope on every commit (i.e. repo-level change). | ||
# | ||
# feat(redis): support for clustering | ||
# chore(redis): update tests | ||
# fix(redis): trim connection string | ||
# ^ ^ ^ | ||
# | | |__ Subject | ||
# | |_______ Scope | ||
# |____________ Type | ||
requireScope: false | ||
# Scope should be lowercase. | ||
disallowScopes: | | ||
[A-Z]+ | ||
# ensures the subject doesn't start with an uppercase character. | ||
subjectPattern: ^(?![A-Z]).+$ | ||
subjectPatternError: | | ||
The subject "{subject}" found in the pull request title "{title}" | ||
didn't match the configured pattern. Please ensure that the subject | ||
doesn't start with an uppercase character. | ||
types: | | ||
break | ||
fix | ||
feat | ||
bug | ||
docs | ||
chore | ||
deps |
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