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

chore: use git-cliff for automatic changelog generation #120

Merged
merged 2 commits into from
May 17, 2024

Conversation

JKRhb
Copy link
Member

@JKRhb JKRhb commented May 16, 2024

Thanks to @jwhb, I discovered git-cliff which is a very neat changelog generator :) This PR introduces a configuration file for git-cliff to the project and applies the tool to the project in order to regenerate the CHANGELOG.md automatically.

In the context of #118, it might also be possible to integrate the changelog generation into the release process, but more on that later.

@codecov-commenter
Copy link

codecov-commenter commented May 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.79%. Comparing base (a751ed8) to head (25a04f0).
Report is 10 commits behind head on main.

Current head 25a04f0 differs from pull request most recent head 6d7e974

Please upload reports for the commit 6d7e974 to get more accurate results.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #120   +/-   ##
=======================================
  Coverage   65.79%   65.79%           
=======================================
  Files          74       74           
  Lines        2383     2383           
=======================================
  Hits         1568     1568           
  Misses        815      815           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JKRhb JKRhb changed the title chore: switch to conventional changelog chore: use git-cliff for automatic changelog generation May 16, 2024
@JKRhb JKRhb force-pushed the conventional-changelog branch from 1682ff6 to 9fc8777 Compare May 16, 2024 22:18
@JKRhb JKRhb marked this pull request as ready for review May 16, 2024 22:23
@JKRhb JKRhb force-pushed the conventional-changelog branch 3 times, most recently from db95f1c to 5a1b21e Compare May 17, 2024 09:58
@JKRhb JKRhb force-pushed the conventional-changelog branch 2 times, most recently from ff9ff87 to 5acbb43 Compare May 17, 2024 10:26
@JKRhb JKRhb force-pushed the conventional-changelog branch from 5acbb43 to c099407 Compare May 17, 2024 10:28
@JKRhb
Copy link
Member Author

JKRhb commented May 17, 2024

I think the config and the new changelog format are now ready to be merged :) In a follow-up PR, I will add some additional documentation on how the new (sadly still somewhat manual) workflow will work alongside the addition of a CONTRIBUTING.md file.

@JKRhb JKRhb merged commit 15ea223 into main May 17, 2024
4 checks passed
@JKRhb JKRhb deleted the conventional-changelog branch May 17, 2024 10:35
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