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

fix(changelog): ensure changelog_message_builder_hook can access and modify change_type #1002

Conversation

noirbizarre
Copy link
Member

Description

This PR ensure that changelog_message_builder_hook has access to change_type and can modify it.

Also, change type remap is only tried if we actually have a parsed message (save a few dict iterations)

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 (N/A)

Expected behavior

changelog_message_builder_hook can access the change_type field (which was removed before the hook was called) and modify it (it was stored and remapped before the hook can modify it).

Steps to Test This Pull Request

  1. write a custom changelog_message_builder_hook
  2. make it read (it should be present) and optionally update the change_type
  3. check that the rendered changelog has the updated change type

Additional context

Copy link

codecov bot commented Mar 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.45%. Comparing base (120d514) to head (f1a10c3).
Report is 194 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1002      +/-   ##
==========================================
+ Coverage   97.33%   97.45%   +0.11%     
==========================================
  Files          42       55      +13     
  Lines        2104     2399     +295     
==========================================
+ Hits         2048     2338     +290     
- Misses         56       61       +5     
Flag Coverage Δ
unittests 97.45% <100.00%> (+0.11%) ⬆️

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 15ea15d into commitizen-tools:master Mar 7, 2024
18 checks passed
@noirbizarre noirbizarre deleted the fix/changelog_message_builder_hook_type branch March 7, 2024 14:32
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.

2 participants