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

Repo: Add a CI check that 'breaking change' PR descriptions start with the right body text #5884

Closed
JoshuaKGoldberg opened this issue Oct 25, 2022 · 0 comments · Fixed by #9050
Closed

Repo: Add a CI check that 'breaking change' PR descriptions start with the right body text #5884

JoshuaKGoldberg opened this issue Oct 25, 2022 · 0 comments · Fixed by #9050
Labels
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs

Comments

@JoshuaKGoldberg
Copy link
Member

Suggestion

Per #5874, breaking change PRs need to start with a description like:

BREAKING CHANGE:
One line description of the change

Example PR: #5036

Let's add in a CI check that, when a PR has the breaking changes label, its body should match that regexp.

I wonder if there's some app we can install for it, with a configurable label -> regex mapping?
@JoshuaKGoldberg JoshuaKGoldberg added repo maintenance things to do with maintenance of the repo, and not with code/docs accepting prs Go ahead, send a pull request that resolves this issue labels Oct 25, 2022
@JoshuaKGoldberg JoshuaKGoldberg changed the title Repo: Add a CI check that 'breaking change' PR descriptions start with the right text Repo: Add a CI check that 'breaking change' PR descriptions start with the right body text Apr 29, 2024
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Apr 29, 2024
Closed
@yeonjuan yeonjuan mentioned this issue May 6, 2024
Merged
3 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: add breaking change pr check ci yeonjuan/typescript-eslint
1 participant
@JoshuaKGoldberg