commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

feat: update default changelog titles

Open paduszyk opened this issue 1 year ago • 6 comments

Description

This updates the default titles of the changelog's sections in ConventionalCommitsCz.

Checklist

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

Expected behavior

Changelogs are more human-readable.

Additional context

Closes #1119.

paduszyk avatar May 24 '24 12:05 paduszyk

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.57%. Comparing base (120d514) to head (34543d5). Report is 471 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1143      +/-   ##
==========================================
+ Coverage   97.33%   97.57%   +0.24%     
==========================================
  Files          42       55      +13     
  Lines        2104     2603     +499     
==========================================
+ Hits         2048     2540     +492     
- Misses         56       63       +7     
Flag Coverage Δ
unittests 97.57% <100.00%> (+0.24%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 24 '24 12:05 codecov[bot]

@paduszyk Hi, would it be possible for us to address https://github.com/commitizen-tools/commitizen/issues/1119#issuecomment-2132866909. I think we're really close to merging!

Lee-W avatar Jul 11 '24 02:07 Lee-W

I would flag this change as breaking as it means any user having a custom change_type_order with the default change_type_map will see its changelog broken without a manual intervention (aka. updating the change_type_order with the new names). So maybe should include this one in the next major (v4?) ?

noirbizarre avatar Aug 20 '24 23:08 noirbizarre

I would flag this change as breaking as it means any user having a custom change_type_order with the default change_type_map will see its changelog broken without a manual intervention (aka. updating the change_type_order with the new names). So maybe should include this one in the next major (v4?) ?

Sounds good! Let me add the label

Lee-W avatar Aug 21 '24 01:08 Lee-W

I think we need to change the test cases

It's been a while... Sorry.

@Lee-W Are you sure? This will result in a relatively large diff, taking into account the source itself will remain basically untouched except the update literals...

paduszyk avatar Nov 06 '25 10:11 paduszyk