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

All pre-release changelog on release. #817

Open
cvalentin-dkt opened this issue Jan 25, 2024 · 6 comments
Open

All pre-release changelog on release. #817

cvalentin-dkt opened this issue Jan 25, 2024 · 6 comments
Assignees
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request

Comments

@cvalentin-dkt
Copy link

Hello,

I'm trying to include the commits from the different prereleases in the changelog of the release, but I can't find how to do it.

An idea ?

@codejedi365
Copy link
Contributor

An interesting concept, this might be a place for a jinja macro to preprocess the release history object that is passed to the environment of the template renderer and then loop through the resulting object.

I've personally never written a jinja macro but that would be where I would start.

@codejedi365
Copy link
Contributor

After re-reading this, I'm not sure what is your intended outcome for the changelog?

  1. Consolidate all prereleases commits to be under the full release version without the prerelease tags as sections?

Or

  1. Consolidate all prereleases commits under the full release version while maintaining each prerelease section?

@cvalentin-dkt
Copy link
Author

What would be interesting is that each "pre-release" has its own change log (as currently).
And when i create the "release", all the previous commits of the different RCs appear in the github changelog.
=> https://github.com/{org}/{repo}/releases/tag/vX.X.X

Actually, just last commit beetwen last RC and release is appear.

@codejedi365
Copy link
Contributor

codejedi365 commented Feb 2, 2024

I think we are talking past each other given the terminology. I was specifically talking about the generation of CHANGELOG.md but it seems you were more interested in the GitHub Release Notes (a per version section of the changes).

My understanding is that right now, the release notes are properly generated for each pre-release but you would like to have the newest full tag release to include all of the commits between it and the last full release as if the prereleases never existed. Is this correct?

Actually, just last commit beetwen last RC and release is appear.

In other words: At the current moment, only commits between the last prerelease and the new release are posted in the new versions release notes. This is my understanding, yes.

I do not believe this is possible at the current time. I have recently made a fix (#822) which likely will provide this functionality for repos that follow the Git Flow merging strategy. I have not yet tested other strategies and I do not know their outcomes but might be related to making this possible.

@ibiscp
Copy link

ibiscp commented Feb 3, 2024

I was hoping to have the same behaviour here, if we generate pre-releases constantly, and after some time we generate a release, the release note is empty, it would make sense to have an option to consolidate all the pre-releases changes in the release.

I believe the rule shoul be:

  • pre-release - Consolidate all changes since the last pre-release or release
  • release - Consolidate all changes since the last release

@codejedi365
Copy link
Contributor

@ibiscp, thank you for providing your input

@codejedi365 codejedi365 self-assigned this Apr 12, 2024
@codejedi365 codejedi365 added this to the Better Changelogs milestone Apr 12, 2024
@codejedi365 codejedi365 added feature A new feature or a feature request confirmed Prevent from becoming stale and removed question labels May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request
Projects
None yet
Development

No branches or pull requests

3 participants