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

feat(changelog): adds a changelog_release_hook called for each release in the changelog #1018

Conversation

noirbizarre
Copy link
Member

Description

This PR adds an optional changelog_release_hook allowing to customize/enrich each changelog release the same way we can customize/enrich each commit

Checklist

  • Add test cases to all the changes you introduce
  • Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

End user and plugin developers can add attributes to each release dict and use them in their changelog template

Steps to Test This Pull Request

  • add a changelog_release_hook to a plugin
  • make it add some attributes to each release
  • access/render them in the changelog template

@noirbizarre noirbizarre force-pushed the feature/changelog-release-hook branch from 479cb09 to 5234ef4 Compare March 11, 2024 13:44
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.46%. Comparing base (120d514) to head (5234ef4).
Report is 210 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1018      +/-   ##
==========================================
+ Coverage   97.33%   97.46%   +0.12%     
==========================================
  Files          42       55      +13     
  Lines        2104     2406     +302     
==========================================
+ Hits         2048     2345     +297     
- Misses         56       61       +5     
Flag Coverage Δ
unittests 97.46% <100.00%> (+0.12%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@noirbizarre noirbizarre merged commit f72828a into commitizen-tools:master Mar 19, 2024
18 checks passed
@noirbizarre noirbizarre deleted the feature/changelog-release-hook branch March 19, 2024 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants