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): changelog_message_build_hook can now generate multiple changelog entries from a single commit #1003

Merged

Conversation

noirbizarre
Copy link
Member

Description

This PR allows to changelog_message_builder_hook to generate multiple changelog entries from a single commit (sequel to #1001).

This PR includes #1002 as it touches the same part (so first commit will automatically be removed as soon as #1002 is merged)

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

If you return an Iterable of parsed messages (aka. dicts) instead of a single one, you can add multiple changelog entries for the same commit.

Steps to Test This Pull Request

  1. Create a custom changelog_message_build_hook
  2. Return an iterable of entries
  3. Generate changelog without failure
  4. Check that all entries are in the changelog

Additional context

Follow #1001
Requires #1002 which is included

@noirbizarre noirbizarre added type: feature A new enhacement proposal scope: plugin labels Mar 6, 2024
@noirbizarre noirbizarre changed the title fix(changelog): ensure changelog_message_builder_hook can access and modify change_type feat(changelog): changelog_message_build_hook can now generate multiple changelog entries from a single commit Mar 6, 2024
@noirbizarre noirbizarre force-pushed the feature/changelog_message_builder_multiple_entries branch 4 times, most recently from de8f151 to 84adeda Compare March 6, 2024 16:11
Copy link

codecov bot commented Mar 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.44%. Comparing base (120d514) to head (1c207df).
Report is 199 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1003      +/-   ##
==========================================
+ Coverage   97.33%   97.44%   +0.11%     
==========================================
  Files          42       55      +13     
  Lines        2104     2391     +287     
==========================================
+ Hits         2048     2330     +282     
- Misses         56       61       +5     
Flag Coverage Δ
unittests 97.44% <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.

…iple changelog entries from a single commit
@noirbizarre noirbizarre force-pushed the feature/changelog_message_builder_multiple_entries branch from 84adeda to 1c207df Compare March 7, 2024 14:34
@noirbizarre noirbizarre merged commit ec2da06 into master Mar 7, 2024
18 checks passed
@noirbizarre noirbizarre deleted the feature/changelog_message_builder_multiple_entries branch March 7, 2024 14:41
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