chore: add breaking change pr check ci #9050
Conversation
|
Thanks for the PR, @yeonjuan! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| function checkTitle(title) { | ||
| if (/!/.test(title)) { | ||
| raiseError(`Do not use exclamation mark ('!') in your PR Title.`); | ||
| } | ||
| } |
There was a problem hiding this comment.
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:
- feat(eslint-plugin): [prefer-optional-chain] support suggesting
!foo || !foo.baras a valid match for the rule #5594 - docs: add missing ! (...) around comparison cases in no-unnecessary-boolean-literal-compare fixer #6968
- feat(eslint-plugin): [no-extra-non-null-assertion] flag optional chain after a non-null assertion #1460
I guess we should restrict only the use of feat(...)!: ... and feat!: .... What do you think?
auvred
added
the
awaiting response
github-actions
bot
removed
the
awaiting response
| } | ||
|
|
||
| function checkTitle(title) { | ||
| if (/^[a-z]+(\([a-z]+\))?!: /.test(title)) { |
There was a problem hiding this comment.
| if (/^[a-z]+(\([a-z]+\))?!: /.test(title)) { | |
| if (/^[a-z]+(\([a-z-]+\))?!: /.test(title)) { |
Without the dash, this regexp won't catch feat(eslint-plugin)!: ...
There was a problem hiding this comment.
Thanks! I fixed it cde7ec4
auvred
added
the
awaiting response
auvred
added
1 approval
| try { | ||
| checkTitle(pullRequest.title); | ||
| checkDescription(pullRequest.body, pullRequest.labels); | ||
| } catch (e) { | ||
| core.setFailed(e.message); | ||
| } |
There was a problem hiding this comment.
Nit: I'd personally rather something like const error = checkTitle(...) || checkDescription(...). But this is fine for an internal script. If it does end up getting changed much later, we can always refactor. 🙂
PR Checklist
Overview
Add CI that checks breaking change pr title and body.
!) in PR title.