-
Notifications
You must be signed in to change notification settings - Fork 1
docs: Add PR title check workflow #322
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
Open
hupling
wants to merge
11
commits into
main
Choose a base branch
from
314-check-pr-title
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
e604ae2
Add PR title check workflow
hupling 531becd
Apply suggestions from code review
hupling ae4fd90
Apply suggestion from @hupling
hupling 117059b
Update pr-title-check.yml
hupling 72717d9
Merge branch 'main' into 314-check-pr-title
hupling 1e8147d
Refactor PR title check to use shell script
hupling a2fe20e
Merge branch 'main' into 314-check-pr-title
hupling ce389e9
Apply suggestions from code review
hupling 0ef1ea9
Apply suggestions from code review
hupling 39a9a9d
add chore
hupling 124d90f
Merge branch 'main' into 314-check-pr-title
hupling 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,26 @@ | ||
| name: "PR Title Check" | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, edited, synchronize, reopened] | ||
|
|
||
| permissions: | ||
| pull-requests: read | ||
|
|
||
| jobs: | ||
| check-title: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check title prefix | ||
| env: | ||
| PR_TITLE: ${{ github.event.pull_request.title }} | ||
|
hupling marked this conversation as resolved.
|
||
| REGEX: "^(feat|fix|docs)(\(.*\))?:" | ||
|
hupling marked this conversation as resolved.
Outdated
|
||
| run: | | ||
| # The regex checks for line start (^), followed by keywords, and an optional description format | ||
| if [[ "$PR_TITLE" =~ $REGEX ]]; then | ||
| echo "Success: PR title starts with a valid prefix." | ||
| else | ||
| echo "Error: PR title must start with 'feat:', 'fix:', or 'docs:'." | ||
| echo "Current title: $PR_TITLE" | ||
| exit 1 | ||
| fi | ||
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.