chore: add artifacthub.io/changes
changelog annotation to the released chart
#949
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds Artifact Hub annotation in the released chart so it can renders its integrated changelog: https://blog.artifacthub.io/blog/changelogs/
Notes:
Only the current version changes have to be included, not the full changelog.
It's the simple form of Artifact Hub changes. Looking at the existing changelog, I'm not sure the more complete form will ever be needed.
I had to strip emojis to avoid having the scalar value broke as single string and failing chart-releaser step:
replaced by
I'm using
yq
to retrieve the version directly from Chart.yaml, easier than the previous method requiring two steps.Tested on a fork:
Entry in CHANGELOG.md starting with an emoji and including a table: https://github.com/lemeurherve/jenkinsci-helm-charts/blob/862770b35ef457f3ffc20b6286e227ee74fef91f/charts/jenkins/CHANGELOG.md?plain=1
Release: https://github.com/lemeurherve/jenkinsci-helm-charts/releases/tag/jenkins-4.8.4
Released Chart.yaml content
Follow-up of:
Submitter checklist
Special notes for your reviewer