-
Notifications
You must be signed in to change notification settings - Fork 507
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: add v0.5.0 release CHANGELOG entry #1190
docs: add v0.5.0 release CHANGELOG entry #1190
Conversation
Skipping CI for Draft Pull Request. |
cc7e0eb
to
ef87a4a
Compare
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! This is a really great list. I have some ideas around how to structure this changelog, but the content looks right to me.
Adding a hold for consensus + we usually try to make the changelog commit the very last thing we merge before publishing a release. /hold |
aacb5d9
to
1e5a3b0
Compare
First @robscott I wanted to point out that I took some of your suggestions, but I did vary some from what you suggested originally. Please take another pass and see if what I have now seems agreeable. Also on this point:
I actually would like to ask that we don't hold this PR, and instead merge it now so the remaining PR's can themselves be responsible for adding |
1e5a3b0
to
11081a2
Compare
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.
Some more suggestions for recategorization, but based on one of your comments you may already have some of this done and just not pushed.
CHANGELOG.md
Outdated
The following are **breaking changes** that have to do specifically with Go | ||
types that changed during this release cycle. |
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 clarify that these are changes that will only affect implementations that rely on the Go types. Most users of Gateway API will be unaffected. I'm a little hesitant to include these because it could set a precedent for always including Go type changes, something that is not done in upstream Kubernetes. Maybe we can add a caveat that this covers the major changes but may not be an exhaustive list?
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.
I've changed the language and added the note you requested in 226a034. Let me know your thoughts.
- Gateway API now includes "Experimental" release channel. Consequently, CRDs now | ||
include `gateway.networking.k8s.io/bundle-version` and | ||
`gateway.networking.k8s.io/channel` annotations. | ||
[#945](https://github.com/kubernetes-sigs/gateway-api/pull/945) |
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.
I think we may need 2 sections here - one to talk about release channels (and likely link to https://gateway-api.sigs.k8s.io/concepts/versioning/), and the other to talk about new features. I think the only new features in this release are parentRef.port
and path redirects and rewrites.
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.
It's not super clear to me what exact action you want taken here, but I did move the reference to 1002 (parentRef.Port) into this section now as that seemed to be something you were getting at. Done in 226a034. Let me know your thoughts.
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.
I think that we need a summary of the release channels at the top, so we can call out which things are in which channel. We probably also need to call out that conformance testing will only work on the experimental channel for now, pardon our dust, etc.
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.
Release channels header now added in 0b7da46 👍
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.
This is looking awesome, I made some suggestions for talking about release channels though.
- Gateway API now includes "Experimental" release channel. Consequently, CRDs now | ||
include `gateway.networking.k8s.io/bundle-version` and | ||
`gateway.networking.k8s.io/channel` annotations. | ||
[#945](https://github.com/kubernetes-sigs/gateway-api/pull/945) |
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.
I think that we need a summary of the release channels at the top, so we can call out which things are in which channel. We probably also need to call out that conformance testing will only work on the experimental channel for now, pardon our dust, etc.
2faab0d
to
0b7da46
Compare
Co-authored-by: Rob Scott <rob.scott87@gmail.com>
Co-authored-by: Rob Scott <rob.scott87@gmail.com>
Thanks @shaneutt! Will plan on merging this in tomorrow as last step before release. Always appreciate more reviews on big PRs like this, but LGTM. /approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: robscott, shaneutt The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/lgtm |
/hold cancel |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This is required to release
v0.5.0
.Which issue(s) this PR fixes:
Fixes #1183
Does this PR introduce a user-facing change?:
NOTES
This was a very manual process that relied on the
git
history as well as Github PR history. It wouldn't be too surprising if I managed to miss some things. We should probably revisit how we manage this in the future to avoid having to do this.