chore: [DevOps] PR Title Linter #273
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,33 @@ | ||
| name: lint pr | ||
|
|
||
| on: | ||
| pull_request_target: | ||
| types: | ||
| - opened | ||
| - edited | ||
| - synchronize | ||
|
|
||
| permissions: | ||
| pull-requests: read | ||
|
|
||
| jobs: | ||
| lint-pr: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: amannn/action-semantic-pull-request@v5 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| scopes: | | ||
| Core | ||
| OpenAI | ||
| Orchestration | ||
| DevOps | ||
| headerPattern: '^(\w.+): (?:\[(\w.+)\] )?(.+)$' | ||
| headerPatternCorrespondence: type, scope, subject | ||
| # for available types, check: | ||
| # https://github.com/commitizen/conventional-commit-types/blob/master/index.json | ||
|
Check warning on line 29 in .github/workflows/pr-lint.yaml
|
||
| subjectPatternError: | | ||
| The subject "{subject}" found in the pull request title "{title}" | ||
| didn't match the configured pattern. Please ensure that the subject | ||
| starts with an uppercase character, e.g. "feat: New Feature". | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Comment/Opinion)
I didn't expect this syntax to be mandatory.
It's not possible to make this more like a warning/notification right?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, at least not per the docs. I checked that it works with Dependabot, but Release PRs would currently fail. Updated the script ✅. For external contributors it should be fine, because it is easy to fix and only occurs after a PR is already raised, i.e. when most of the work is already done.