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

Track the Helm Chart changelogs #19

Open
1 task done
imgios opened this issue Apr 19, 2024 · 3 comments
Open
1 task done

Track the Helm Chart changelogs #19

imgios opened this issue Apr 19, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request keep open Issue or pull request that must not be closed by Stale bot needs triage This issue may need triage. Remove it if it has been sufficiently triaged

Comments

@imgios
Copy link
Collaborator

imgios commented Apr 19, 2024

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

  • I agree to follow this project's Code of Conduct
@imgios imgios added documentation Improvements or additions to documentation enhancement New feature or request needs triage This issue may need triage. Remove it if it has been sufficiently triaged labels Apr 19, 2024
@fonzdm
Copy link
Owner

fonzdm commented Apr 20, 2024

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
Copy link
Collaborator Author

imgios commented Apr 20, 2024

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 imgios added this to the first release milestone May 9, 2024
@imgios
Copy link
Collaborator Author

imgios commented May 9, 2024

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.

@fonzdm fonzdm removed this from the first release milestone May 9, 2024
@imgios imgios added the keep open Issue or pull request that must not be closed by Stale bot label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request keep open Issue or pull request that must not be closed by Stale bot needs triage This issue may need triage. Remove it if it has been sufficiently triaged
Projects
None yet
Development

No branches or pull requests

2 participants