lunny/helm-chart
1
0
Fork 0
Code Issues 36 Pull Requests 14 Actions Packages Projects Releases 93 Wiki Activity

Rethink changelog approach #247

New Issue
Closed
opened 2021-11-16 19:14:34 +00:00 by justusbunsi · 1 comment
justusbunsi commented 2021-11-16 19:14:34 +00:00 (Migrated from gitea.com)
Copy Link

After 5.0 is released, we should rethink the current changelog approach. Major versions are quite likely to contain breaking changes which are documented with more details than non-breaking changes in patches.

Having those inside the README file bloats it a lot. Especially located above the actual documentation where it hides the actual documentation for new users.

My suggestion is to move the actual changelog either to the end of the file and just refer to it at the top, or move it into another file and include this into the release process.

Maybe it is even possible to auto-generate the release notes from PRs marked as breaking. This would require a user friendly PR description but reduces the manual overhead, since it's already written for the PR reviewers. ?

After 5.0 is released, we should rethink the current changelog approach. Major versions are quite likely to contain breaking changes which are documented with more details than non-breaking changes in patches. Having those inside the README file bloats it a lot. Especially located above the actual documentation where it hides the actual documentation for new users. My suggestion is to move the actual changelog either to the end of the file and just refer to it at the top, or move it into another file and include this into the release process. Maybe it is even possible to auto-generate the release notes from PRs marked as breaking. This would require a user friendly PR description but reduces the manual overhead, since it's already written for the PR reviewers. ?
👍 2 ❤️ 1
viceice commented 2021-11-23 14:40:03 +00:00 (Migrated from gitea.com)
Copy Link

I think a good start will be to move the changes to the bottom. This is done by all bitnami images /charts too. ?

I think a good start will be to move the changes to the bottom. This is done by all bitnami images /charts too. ?
👍 1
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
has/backport
in progress
invalid
kind/breaking
kind/bug
kind/build
kind/dependency
kind/deployment
kind/docs
kind/enhancement
kind/feature
kind/lint
kind/proposal
kind/question
kind/refactor
kind/security
kind/testing
kind/translation
kind/ui
need/backport
priority/critical
priority/low
priority/maybe
priority/medium
reviewed/duplicate
reviewed/invalid
reviewed/wontfix
skip-changelog
status/blocked
status/needs-feedback
status/needs-reviews
status/wip
upstream/gitea
upstream/other
No Label
kind/proposal
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: lunny/helm-chart#247
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?