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.

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

Merged

Conversation

shaneutt
Copy link
Member

@shaneutt shaneutt commented Jun 7, 2022

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?:

NONE

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.

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 7, 2022
@k8s-ci-robot k8s-ci-robot requested review from robscott and thockin June 7, 2022 22:20
@shaneutt shaneutt force-pushed the shaneutt/v0.5.0-changelog branch 3 times, most recently from cc7e0eb to ef87a4a Compare June 7, 2022 22:28
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 7, 2022
@shaneutt shaneutt marked this pull request as ready for review June 7, 2022 22:29
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 7, 2022
Copy link
Member

@robscott robscott left a 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.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@robscott
Copy link
Member

robscott commented Jun 7, 2022

Adding a hold for consensus + we usually try to make the changelog commit the very last thing we merge before publishing a release.

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 7, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 8, 2022
@shaneutt shaneutt force-pushed the shaneutt/v0.5.0-changelog branch from aacb5d9 to 1e5a3b0 Compare June 8, 2022 13:31
@shaneutt
Copy link
Member Author

shaneutt commented Jun 8, 2022

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:

Adding a hold for consensus + we usually try to make the changelog commit the very last thing we merge before publishing a release.

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 CHANGELOG.md entries. I made a proposal in #1193 aimed at making updating the CHANGELOG.md a consistent thing over time between all contributors so that we don't have to take a long time to compile a list right before release. Please let me know your thoughts and please review that PR.

@shaneutt shaneutt force-pushed the shaneutt/v0.5.0-changelog branch from 1e5a3b0 to 11081a2 Compare June 8, 2022 14:04
Copy link
Member

@robscott robscott left a 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 Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated
Comment on lines 131 to 132
The following are **breaking changes** that have to do specifically with Go
types that changed during this release cycle.
Copy link
Member

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?

Copy link
Member Author

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.

Comment on lines +46 to +70
- 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)
Copy link
Member

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.

Copy link
Member Author

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.

Copy link
Contributor

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.

Copy link
Member Author

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 👍

CHANGELOG.md Outdated Show resolved Hide resolved
@shaneutt shaneutt requested a review from robscott June 8, 2022 18:04
@robscott robscott added this to the v0.5.0 milestone Jun 9, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
@shaneutt shaneutt requested a review from robscott June 9, 2022 22:14
Copy link
Contributor

@youngnick youngnick left a 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.

Comment on lines +46 to +70
- 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)
Copy link
Contributor

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.

CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@shaneutt shaneutt force-pushed the shaneutt/v0.5.0-changelog branch from 2faab0d to 0b7da46 Compare June 10, 2022 15:25
@shaneutt shaneutt requested a review from youngnick June 10, 2022 15:26
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Rob Scott <rob.scott87@gmail.com>
@shaneutt shaneutt requested a review from robscott June 13, 2022 22:49
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Rob Scott <rob.scott87@gmail.com>
@shaneutt shaneutt requested a review from robscott June 13, 2022 23:22
@robscott
Copy link
Member

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

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 13, 2022
@youngnick
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 15, 2022
@robscott
Copy link
Member

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 15, 2022
@k8s-ci-robot k8s-ci-robot merged commit e007d2c into kubernetes-sigs:master Jun 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CHANGELOG for v0.5.0
4 participants