-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Check that PRs' CHANGELOG.md changes don't modify already-released content in CI
#8351
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
base: trunk
Are you sure you want to change the base?
Check that PRs' CHANGELOG.md changes don't modify already-released content in CI
#8351
Conversation
58ba751 to
8b3d6ff
Compare
|
Recent violators of the check I'm adding here that I had to fix in #8407: |
|
Sigh, this check is running into issues with GitHub's default |
556a765 to
e686fa7
Compare
|
I have several PRs demonstrating that core logic works here:
These are present in the check's unit tests in There are some questions that are still open for this, but none are blocking until we make this check required:
|
c13a16a to
8f102f2
Compare
.github/workflows/changelog.yml
Outdated
| @@ -0,0 +1,42 @@ | |||
| name: Check `CHANGELOG.md` | |||
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.
Bikeshedding for the file's name welcome welcome!
.github/workflows/changelog.yml
Outdated
| changelog: | ||
| timeout-minutes: 1 | ||
|
|
||
| name: Check `CHANGELOG` for errors |
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.
Bikeshedding for the job's name welcome!
2335cc5 to
06acbe0
Compare
06acbe0 to
7ea2757
Compare
| #[test] | ||
| fn change_in_unreleased_not_rejected() {} | ||
|
|
||
| #[test] | ||
| fn change_above_unreleased_not_rejected() {} |
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.
todo: Finish these tests. 😅
We've had recurring issues with PRs'
CHANGELOG.mdentries going stale, particularly when PRs are filed close to a regular release date. This PR tries to make this by creating a CI check that fails when a PR modifies the changelog and it detects changes outside the## Unreleasedsection header.This is an MVP that is not yet suitable as a required check, because there is no escape hatch for cases where we do want to change released changelog content. The intent is to enable this once some follow-up to add such an escape hatch has achieved consensus and is implemented.