gha: enforce CHANGELOG.md entries for PRs #5047
Conversation
cyphar
force-pushed
the
gha-enforce-changelog
branch
5 times, most recently
from
5b81927 to
ec76631
Compare
Each release requires going through the list of PRs and trying to parse out what a reasonable changelog entry is (possibly ~6 months after the patch was last discussed and merged), which makes preparing release notes quite time-consuming. Given that the moment when the patch is merged is when the information about the imapct of a patch is most apparent to the author and reviewers, it seems prudent to require that every PR have a CHANGELOG.md change. Trivial patches can just add a dummy entry in the changelog (in future, we can expand this script to skip over commits that have some special tag to avoid the need for dummy entries). Signed-off-by: Aleksa Sarai <[email protected]>
cyphar
force-pushed
the
gha-enforce-changelog
branch
from
c8464c3 to
ba302df
Compare
cyphar
added
backport/1.2-todo
| opencontainers/cgroups#50) | ||
|
|
||
| ### Changed ### | ||
| - CI: All PRs now require a corresponding `CHANGELOG.md` change be included, |
There was a problem hiding this comment.
This is likely to just result in making the changelog lengthy and unreadable.
Also we will no longer be able to merge dependabot PRs.
There was a problem hiding this comment.
Maybe just migrate the changelog to wiki so that we can add changelog items without submitting PRs
There was a problem hiding this comment.
How will we make sure it gets updated on time? The current situation is that PRs get merged and then you need to figure out what to write for the changelog months later.
I would prefer to not have it be mandatory but it seems we are nowhere near consistent enough to enforce this through regular reviews.
For dependabot or minor PRs, I can adjust this CI job to allow-list PRs with special tags or by special committer emails...
One other option would be to enforce having a "for the changelog" section of the PR but then we would probably want to script collating them...
2 participants
Each release requires going through the list of PRs and trying to parse
out what a reasonable changelog entry is (possibly ~6 months after the
patch was last discussed and merged), which makes preparing release
notes quite time-consuming.
Given that the moment when the patch is merged is when the information
about the imapct of a patch is most apparent to the author and
reviewers, it seems prudent to require that every PR have a CHANGELOG.md
change. Trivial patches can just add a dummy entry in the changelog (in
future, we can expand this script to skip over commits that have some
special tag to avoid the need for dummy entries).
Signed-off-by: Aleksa Sarai [email protected]