-
Notifications
You must be signed in to change notification settings - Fork 508
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
docs: update PR template for CHANGELOG reminder #1193
Conversation
Skipping CI for Draft Pull Request. |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: shaneutt The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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.
Thanks @shaneutt! I like this idea. I'm a bit concerned that we may end up with a lot of merge conflicts on CHANGELOG.md if we take this approach, but it could be worth trying to see if that really is an issue.
@@ -14,6 +14,10 @@ | |||
- [v0.1.0-rc2](#v010-rc2) | |||
- [v0.1.0-rc1](#v010-rc1) | |||
|
|||
## Unreleased | |||
|
|||
Changes that are in `main` but have not yet made it to a release. |
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.
Maybe add some kind of note here to indicate that unreleased changes may be rolled back or changed prior to a release.
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.
Sounds good. Change in 1e06e53
|
||
**PR Checklist** | ||
|
||
- [ ] the `CHANGELOG.md` was updated with any user-facing changes |
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.
If we're doing this, we probably want to remove the release-note section above
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.
👍 Changed in 1e06e53
@youngnick any feelings on this one? |
In Contour, we use a Edit: I think that the current idea is okay for now though. |
Alright, sounds like so far people are OK with trying this out. I'll bring it up at monday's meeting too, if it's not otherwise merged before then. Thank you. |
@youngnick, @robscott just wanted to ping on this one because it's been sitting a while: think we're OK to give this one a try? |
Actually before we go too far down this path, maybe we should try the upstream scripting for release notes generation: https://github.com/kubernetes/release/blob/master/cmd/release-notes/README.md. |
Alright, that goes a bit beyond the scope of what I was trying to accomplish here, so I'll consider this one closed for the time being and then we should probably create a follow up issue for that 👍 |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
While working on #1183 I found it was quite laborious to search all PR history and fill in the
CHANGELOG.md
retroactively.This PR is a proposal instead to indicate that user-facing changes must be accompanied by a
CHANGELOG.md
update in the PR they are introduced, adding a PR checklist to the PR template. Consequently, this also proposes that we keep a heading ofUnreleased
in the CHANGELOG as a place for contributors to place their entries prior to release to reduce confusion about where it should go.