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

Document Breaking Changes #171

Open
clux opened this issue Mar 15, 2023 · 2 comments
Open

Document Breaking Changes #171

clux opened this issue Mar 15, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@clux
Copy link

clux commented Mar 15, 2023

Is your feature request related to a problem ?

A common convention for helm charts is to document breaking changes in the readme of the chart that is being upgraded.

Having this would be very useful because it's hard to scan commits across a whole repo for changes that may be relevant. When users are applying helm charts through, say, terraform, the diffs are not always visible to people.

I ended up scanning through flux commits yesterday to find the major bump to see if there was anything to beware of, only to be bitten by a much more significant breaking change in 2.2.0 (#144) that effectively ended up taking down a whole cluster when the unnoticed change uninstalled the kustomization crds.

Describe the solution you'd like.

An "Upgrading" section in the chart README ala e.g.:

Describe alternatives you've considered.

NONE

Additional context.

Sorry about the negative tone here. I do think the charts are in general great so thank you for all the work that goes into them. It would just simplify the downstream pickup quite a bit to have changes documented.

@clux clux added the enhancement New feature or request label Mar 15, 2023
@haarchri
Copy link
Collaborator

At the moment we have the change log in
inhttps://artifacthub.io/packages/helm/fluxcd-community/flux2 click on changelog - but yes would be better to have a readme or changelog section in the repo

@clux
Copy link
Author

clux commented Mar 15, 2023

Ah, thanks had not seen that.

Perhaps a separate classification problem, but https://artifacthub.io/packages/helm/fluxcd-community/flux2?modal=changelog&version=2.2.0 also does not document 2.2.0 as a breaking change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants