How to add notes to release archive?

helm / chart-releaser-action

A GitHub Action to turn a GitHub project into a self-hosted Helm chart repo, using helm/chart-releaser CLI tool

https://github.com/helm/chart-releaser

Apache License 2.0

543 stars 199 forks source link

How to add notes to release archive? #119

Open djklim87 opened 1 year ago

djklim87 commented 1 year ago

Does this package has ability to add release notes to result release? Cause as I see there always one text - Repository "about" description

jftanner commented 1 year ago

I've tried adding release-notes-file to my cr.yaml, but no luck.

jftanner commented 1 year ago

Ah, I figured it out!

The filepath is relative to the chart, not the repository. I solved the problem by generating the changelog in the chart repo. (You still need some additional mechanism to generate the changelog. I'm using semantic-release for that purpose.)

djklim87 commented 1 year ago

Can you write a small guide which and where you put?

jftanner commented 1 year ago

I can at least share what I've got so far. It's far from done, but the semantic-release and chart-release parts seem to be working.

Chart-Releaser config: cr.yaml
Semantic-Release config: release.config.cjs
Github Actions Workflow: .github/workflows/release.yaml

Note: In my case, I have a single chart in the /microservices directory. For multiple charts, a more complicated semantic-release setup would be required.