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

Provide consolidated changelog for end-users #4392

Open
Nevon opened this issue Feb 10, 2025 · 1 comment
Open

Provide consolidated changelog for end-users #4392

Nevon opened this issue Feb 10, 2025 · 1 comment
Assignees
Labels
type/documentation Documentation update/creation type/enhancement New feature or request

Comments

@Nevon
Copy link

Nevon commented Feb 10, 2025

What I'd like:
As a user of bottlerocket, I would like a simple way to understand what has changed between different versions of the OS. This used to be fairly simple by reading the release notes here on Github (example). But with the move of a lot of functionality out into bottlerocket-core-kit, twoliter etc. this is now harder for two reasons:

  1. The actual changelog for each given package lives in its own repository, and the release notes don't link to that changelog.
  2. The bottlerocket release notes for a given version don't tell you what version of for example twoliter it is changing from. Only what version it is changing to.

This means that today for example when I'm upgrading from 1.31.0 to 1.32.0 I have to have the release notes for both versions up, and for each dependency check what version it was in 1.31.0 and what version it is in 1.32.0 and then go through the release notes for each of those versions in each separate repository.

Given the close relationship between Bottlerocket the OS and bottlerocket-core-kit, twoliter etc. it would be really helpful if there was a way to get a consolidated changelog that for a given version of Bottlerocket shows what changes there were in the dependencies, not just that the new version is now X.

Any alternatives you've considered:

Bottlerocket.dev could provide this information. Today it just links to the github release page. It does also list all the versions of various packages, so it stands to reason that it could provide the changelog for those packages between the current version and the previous version. However, today the website [doesn't keep up to date with the OS releases](The website doesn't provide any release notes, and just links to the github release page of this repository, and the website doesn't keep up to date with OS versions anyway.).

A smaller but still helpful change would be if the release notes said "Update bottlerocket-core-kit from 5.4.1 to 5.4.2" and linked to the release notes of bottlerocket-core-kit 5.4.2. At least that would make it faster to do this review manually.

@Nevon Nevon added status/needs-triage Pending triage or re-evaluation type/enhancement New feature or request labels Feb 10, 2025
@yeazelm
Copy link
Contributor

yeazelm commented Feb 17, 2025

Hello @Nevon, thanks for cutting this issue! We have been trying to find the right balance of detail in our CHANGELOGs and release notes since breaking the packages out into kits. This feedback is great to help us hone in on what is useful!

A smaller but still helpful change would be if the release notes said "Update bottlerocket-core-kit from 5.4.1 to 5.4.2" and linked to the release notes of bottlerocket-core-kit 5.4.2. At least that would make it faster to do this review manually.

It makes sense to make the references to the kit updates links to those release notes so that the individual changes are quick to find. We have been operating under the assumption that most users don't care about twoliter changes or things like minor package updates in the bottlerocket-core-kit so we haven't been bringing them all the way to the top CHANGELOG it bottlerocket-os/bottlerocket releases. They may not make their way back like you saw in the v1.15.0 release notes but we can at least make it easy to get this info with links to the respective changes in those repos. We'll aim to do some of these changes over the next few releases to see if this solves your problem.

@yeazelm yeazelm added type/documentation Documentation update/creation and removed status/needs-triage Pending triage or re-evaluation labels Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation Documentation update/creation type/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants