Skip to content
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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 4 commits into from
Jul 31, 2024
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
42cdffc
impr: initial github action
rizwanmustafa Jul 31, 2024
7596068
impr: add regex for checking multiple authors, thanks mio
rizwanmustafa Jul 31, 2024
638a02a
impr: make regex be intolerant to space and modify error logs
rizwanmustafa Jul 31, 2024
f8edf8c
update comment
Miodec Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions .github/workflows/semantic-pr-title.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- opened
- edited
- synchronize
- reopened

permissions:
pull-requests: write
Expand All @@ -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 }}
Expand All @@ -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.
Expand All @@ -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:

Expand Down
Loading