-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
chore: add breaking change pr check ci #9050
Merged
JoshuaKGoldberg
merged 3 commits into
typescript-eslint:main
from
yeonjuan:add-bc-pr-ci
May 26, 2024
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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,6 @@ | ||
name: Validate Breaking Change PR | ||
description: Validate breaking change PR title and description | ||
|
||
runs: | ||
using: node20 | ||
main: index.js |
This file contains 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,60 @@ | ||
const core = require('@actions/core'); | ||
const github = require('@actions/github'); | ||
|
||
function raiseError(message) { | ||
throw new Error(message); | ||
} | ||
|
||
async function getPullRequest() { | ||
const client = github.getOctokit(process.env.GITHUB_TOKEN); | ||
|
||
const pr = github.context.payload.pull_request; | ||
if (!pr) { | ||
throw new Error( | ||
"This action can only be invoked in `pull_request_target` or `pull_request` events. Otherwise the pull request can't be inferred.", | ||
); | ||
} | ||
|
||
const owner = pr.base.user.login; | ||
const repo = pr.base.repo.name; | ||
|
||
const { data } = await client.rest.pulls.get({ | ||
owner, | ||
repo, | ||
pull_number: pr.number, | ||
}); | ||
|
||
return data; | ||
} | ||
|
||
function checkTitle(title) { | ||
if (/!/.test(title)) { | ||
raiseError(`Do not use exclamation mark ('!') in your PR Title.`); | ||
} | ||
} | ||
|
||
function checkDescription(body, labels) { | ||
if (!labels.some(label => label.name === 'breaking change')) { | ||
return; | ||
} | ||
const [firstLine, secondLine] = body.split(/\r?\n/); | ||
|
||
if (!firstLine || !/^BREAKING CHANGE:/.test(firstLine)) { | ||
raiseError(`Breaking change PR body should start with "BREAKING CHANGE:"`); | ||
} | ||
if (!secondLine) { | ||
raiseError(`The description of breaking change is missing.`); | ||
} | ||
yeonjuan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
async function run() { | ||
const pullRequest = await getPullRequest(); | ||
try { | ||
checkTitle(pullRequest.title); | ||
checkDescription(pullRequest.body, pullRequest.labels); | ||
} catch (e) { | ||
core.setFailed(e.message); | ||
} | ||
Comment on lines
+58
to
+63
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: I'd personally rather something like |
||
} | ||
|
||
run(); |
This file contains 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,21 @@ | ||
name: Semantic Breaking Change PR | ||
|
||
on: | ||
pull_request_target: | ||
types: | ||
- opened | ||
- edited | ||
- synchronize | ||
- labeled | ||
- unlabeled | ||
auvred marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
jobs: | ||
main: | ||
name: Validate Breaking Change PR | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: ./.github/actions/prepare-install | ||
- uses: ./.github/actions/breaking-pr-check | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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.
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.
Hmmm, isn't this too restrictive? I can imagine the several cases when
!
might be used not in the "breaking changes" position (before the semicolon)Here are several real world PRs that have an exclamation mark in their titles:
!foo || !foo.bar
as a valid match for the rule #5594I guess we should restrict only the use of
feat(...)!: ...
andfeat!: ...
. What do you think?