Repository navigation
ci: check PR titles with a workflow instead of the semantic-prs app #2813
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 was deleted.
Oops, something went wrong.
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,37 @@ | ||
| name: PR Title | ||
| # PRs are squash-merged, so the PR title becomes the commit message | ||
| # and a line in the release notes. This checks it follows the format: | ||
| # new icon: <name> (<versions>) update icon: <name> (<versions>) | ||
| # <type>[(scope)][!]: <description> (conventional commits, for everything else) | ||
| # Fixing the title re-runs this check. | ||
| on: | ||
| pull_request: | ||
| types: [opened, edited, synchronize, reopened] | ||
|
|
||
| permissions: {} | ||
|
|
||
| jobs: | ||
| title: | ||
| name: Semantic PR | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 | ||
| with: | ||
| script: | | ||
| const title = context.payload.pull_request.title; | ||
| const types = ['new icon', 'update icon', 'feat', 'fix', 'docs', 'chore', 'ci', 'refactor', 'style', 'test', 'perf', 'build', 'revert']; | ||
|
Snailedlt marked this conversation as resolved.
|
||
| const conventional = new RegExp(`^(${types.join('|')})(\\([\\w$.\\-*/ ,]+\\))?!?: \\S`); | ||
| if (conventional.test(title) || /^Revert ".+"$/.test(title)) { | ||
| core.info(`"${title}" is a valid PR title.`); | ||
| return; | ||
| } | ||
| // The summary is rendered as HTML/Markdown: show the title as text | ||
| const shown = title.replace(/[<>&`]/g, c => `&#${c.charCodeAt(0)};`); | ||
| core.summary.addRaw([ | ||
| `"${shown}" isn't a valid PR title. The title becomes the commit message and the release-notes line, so it needs one of these formats:`, | ||
| '', | ||
| '- `new icon: <name> (<versions>)` or `update icon: <name> (<versions>)`, e.g. `new icon: vlang (original, plain)`', | ||
| `- \`<type>: <description>\`, e.g. \`fix: correct the jekyll wordmark\`, where type is one of ${types.slice(2).map(t => '`' + t + '`').join(', ')}`, | ||
| ].join('\n')); | ||
| await core.summary.write(); | ||
| core.setFailed(`Invalid PR title: "${title}". See the job summary for the expected format.`); | ||
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.