search

fonzdm / servarr

Just trying to make a Servarr helm chart. Help
GNU Affero General Public License v3.0
6 stars 1 forks source link

Track the Helm Chart changelogs #19

Open imgios opened 6 months ago

imgios commented 6 months ago

Description

I think it would be good to have a file in the repository root (e.g., CHANGELOG.md) to keep track of the Helm Chart versions changelog.

Solution you'd like

I'm thinking about having a CHANGELOG.md file next to the README.md that follows the Keep a Changelog structure.

Code of Conduct

fonzdm commented 6 months ago

Nice idea! This will be really helpful to keep track of everything we do. Do you suggest a release-based changelog or something more granular (like, for every significant PR we do into master)?

Moreover, do you know of any method (pipeline based probably) to enforce a changelog entry upon release/modifications?

imgios commented 6 months ago

Nice idea! This will be really helpful to keep track of everything we do. Do you suggest a release-based changelog or something more granular (like, for every significant PR we do into master)?

Often one PR means something a new feature or a bug fix, so something to share with an user, and this also means having an entry in the Changelog version as "Added", "Fixed", "Removed", etc. Said that, I would keep a release-based changelog with an entry for each feature/bug-fix to track, or more in general with the info relevant for the end-user.

Moreover, do you know of any method (pipeline based probably) to enforce a changelog entry upon release/modifications?

Not yet, I can take a look into it and let you know 😊

imgios commented 5 months ago

Coming back to this, I found out few actions that tries to automate the Changelog generation based on several factors (e.g., PRs), and some requires at least 2 pre-existing tags to work. Take a look to:

But I didn't find any action (or any other automatic way) that uses the Keep a Changelog structure.