impr(ci): verify pr titles include author name (@rizwanmustafa) (#5707)

!nuf
This commit is contained in:
Christian Fehmer 2024-08-01 12:48:12 +02:00 committed by GitHub
parent 8bc47960ef
commit c6550eb8df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 16 additions and 5 deletions

View file

@ -12,9 +12,9 @@
- Also please add a screenshot of the theme, it would be extra awesome if you do so!
- [ ] Check if any open issues are related to this PR; if so, be sure to tag them below.
- [ ] Make sure the PR title follows the Conventional Commits standard. (https://www.conventionalcommits.org for more info)
- [ ] Make sure to include your GitHub username inside parentheses at the end of the PR title
- [ ] Make sure to include your GitHub username prefixed with @ inside parentheses at the end of the PR title.
<!-- label(optional scope): pull request title (your_github_username) -->
<!-- label(optional scope): pull request title (@your_github_username) -->
<!-- I know I know they seem boring but please do them, they help us and you will find out it also helps you.-->

View file

@ -6,6 +6,7 @@ on:
- opened
- edited
- synchronize
- reopened
permissions:
pull-requests: write
@ -15,7 +16,8 @@ jobs:
name: check
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5
- name: Lint and verify PR title
uses: amannn/action-semantic-pull-request@v5
id: lint_pr_title
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@ -34,7 +36,16 @@ jobs:
style
test
requireScope: false
subjectPattern: ^.+ \(@[^ ,]+(, @[^ ,]+)*\)$
subjectPatternError: |
Title "{title}"
didn't match the configured pattern. Please ensure that the title
contains your name so that you can be credited in our changelog.
A correct version would look something like:
feat: add new feature (@github-username)
fix: resolve bug (@github-username)
- uses: marocchino/sticky-pull-request-comment@v2
# When the previous steps fails, the workflow would stop. By adding this
# condition you can continue the execution with the populated error message.
@ -44,7 +55,7 @@ jobs:
message: |
Hey there and thank you for opening this pull request! 👋🏼
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and also include the author name at the end inside round brackets. It looks like your proposed title needs to be adjusted.
Details: