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

Proposal: Harbor-Helm shoould maintain a Changelog #1177

Open
Vad1mo opened this issue Apr 13, 2022 · 0 comments
Open

Proposal: Harbor-Helm shoould maintain a Changelog #1177

Vad1mo opened this issue Apr 13, 2022 · 0 comments

Comments

@Vad1mo
Copy link
Member

Vad1mo commented Apr 13, 2022

When new Helm charts are released, it is difficult to see what has changed and what impacts it has on the upgrade and deployment.

One easy way to publish a Changelog can be done with artifacthub.io. Project Harbor is already listed https://artifacthub.io/packages/helm/harbor/harbor

The only thing needed is to add annotations to Chart.yaml

Artifact Hub annotations in Chart.yaml:

annotations:
  artifacthub.io/changes: |
    - Added cool feature
    - Fixed minor bug    

See full example: https://artifacthub.io/docs/topics/annotations/helm/
and code https://github.com/artifacthub/hub/blob/master/charts/artifact-hub/Chart.yaml

The result will be displayed by artifacthub like this:

image

It is also possible to reference directly to the Changelog from the git repo or download the markdown version containing the full change log.

@Vad1mo Vad1mo changed the title Proposal to Generate a Changelog Proposal: Harbor-Helm shoould maintain a Changelog Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant