aws / karpenter-provider-aws

Karpenter is a Kubernetes Node Autoscaler built for flexibility, performance, and simplicity.
https://karpenter.sh
Apache License 2.0
6.68k stars 934 forks source link

Release notes don't properly categorize / surface some changes #6361

Open jcmcken opened 3 months ago

jcmcken commented 3 months ago

Description

How can the docs be improved?

I'm not familiar with how the release notes are generated. But here's an example to illustrate the problem:

0.34.0 introduced disruption budgets as a new feature (at least, that's what I would consider it, since new fields are added to the configs). But if you look at the release notes it's not mentioned under Features, yet is mentioned in various other places like Documentation (because the upgrade guide does mention it).

It's possible I just happened to run into the one case where something was missed. If so feel free to close this issue. Or maybe this wasn't classified as a feature but just a modification of how disruption works in Karpenter. In that case, maybe another section like Important Changes and some info similar to what's in the upgrade guide would be useful.

jmdeal commented 3 months ago

I think this is largely a consequence of our release notes being split between two repositories: the upstream library (kubernetes-sigs/karpenter) and the AWS provider (this repo). These release versions are currently coupled, so to get a full picture you'd want to check out the releases in both versions. For example, in the upstream v0.34.0 release disruption budgets is listed as a feature.

It would be nice to have a unified changelog, since the provider is the product that users interact with at the end of the day. I think this is especially true as we move to decouple the library and provider release versions post v1.

jcmcken commented 3 months ago

Thanks, that makes a lot of sense. I didn't realize there was a separate repo.