Skip to content

Conversation

@barskern
Copy link
Contributor

Here is an example cliff.toml to generate the CHANGELOG from the commit history.

It might be a worthty trade of to have a verbose CHANGELOG for the simplicity of not having to manually make changes to it. It does mean that the commit messages should be clear on what they do. Probably move to enforce conventional commits with a tool such as committed, and be more deliberate when merging PRs, that the commits are perhaps rebased or squashed to be meaningful.

The exact format and filtering of the changelog can be modified. For example, for now all commits concerning style or formatting are hidden from the changelog.

@barskern barskern requested a review from a team as a code owner September 23, 2025 14:13
@barskern barskern force-pushed the add-generated-changelog branch 2 times, most recently from e7babd0 to 6458ce2 Compare September 23, 2025 14:44
@olantwin
Copy link
Contributor

Can we maybe configure this to start at commit X and have the old manually written changelog as footer?

For the script, it might be good to just assume git-cliff is installed. I'd probably install it locally on my different development machines.

@barskern
Copy link
Contributor Author

Can we maybe configure this to start at commit X and have the old manually written changelog as footer?

Yeah, that we could certainly do! I will change this PR to implement that, and when you do the next release, we can do the necessary steps to start with the new generation.

For the script, it might be good to just assume git-cliff is installed. I'd probably install it locally on my different development machines.

Sure, that is probably a bit cleaner. I will change it!

@barskern barskern force-pushed the add-generated-changelog branch 3 times, most recently from 5b65f82 to 97d11d4 Compare September 30, 2025 11:46
@barskern barskern force-pushed the add-generated-changelog branch from 601c8a7 to 2d95282 Compare September 30, 2025 11:52
@barskern
Copy link
Contributor Author

Thank you for your patience regarding the update spam. I think I should meet your goals now. We can keep the PR open until you are ready to make the transition, and then we can rebase on master, update the footer, update the from_ref commit sha and make the merge.

@olantwin
Copy link
Contributor

olantwin commented Oct 1, 2025

Thank you for your patience regarding the update spam. I think I should meet your goals now. We can keep the PR open until you are ready to make the transition, and then we can rebase on master, update the footer, update the from_ref commit sha and make the merge.

Great! This is now pretty much what I had in mind. I'll probably tag a release for the target production, and then after that we can merge this to maintain the changelog going forward,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants