artifacthub / hub

Find, install and publish Cloud Native packages
https://artifacthub.io
Apache License 2.0
1.66k stars 227 forks source link

Support rendering CHANGELOG.md in helm charts #2925

Closed josephprem closed 1 year ago

josephprem commented 1 year ago

Including CHANGELOG.txt or CHANGELOG.md is a standard practice in SDLC. It is fantastic that hub already supports rendering the Changelog in the UI, however I understand this is available when artifacthub.io/changes annotation is added to Chart.yaml.

The request here is to extended this feature to automatically detect CHANGELOG.md file when available for a chart and render it in the UI.

Hope this request would be considered and easy to implement.

Regards, Prem

tegioz commented 1 year ago

Hi @josephprem 👋

We discussed this a bit when we added the changelog feature. You can see the whole conversation in Slack for more details about why we opted for not adding it back then.

As of today, ~2.5 years after it was added, ~900 packages on artifacthub.io (out of ~12k available) are using the artifacthub.io/changes annotation (which is common across all kinds supported) to describe their packages' changes and the number keeps growing. We've run a quick check and, excluding the TrueCharts repo, ~300 charts include a changelog file (some of them also include the AH annotation, so they overlap), so it isn't something widely used in charts.

Please take a look at the Slack discussion when you have a chance, hope the reasoning makes sense 🙂

tegioz commented 1 year ago

Will close this one for now as at the moment we'd rather not to add this feature. Thank you very much anyway! 🙂