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: update default changelog titles #1143

Open
wants to merge 2 commits into
base: v4
Choose a base branch
from

Conversation

paduszyk
Copy link
Contributor

Description

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

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

Changelogs are more human-readable.

Additional context

Closes #1119.

Copy link

codecov bot commented May 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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%) ⬆️

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.

@Lee-W Lee-W added pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check and removed pr-status: wait-for-review labels May 27, 2024
ConventionalCommitsCz,
"change_type_map",
{
"feat": "Feat",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are the tests using the old format?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not want to change the tests. So I applied mocking instead to hard-coding the new values.

IMHO: For tests, the names should not matter, I guess. The point is what the values are actually used for.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be a bit confusing as these are no longer the actual default_change_type_map when someone's tracing the test cases, they might be misled

@Lee-W
Copy link
Member

Lee-W commented Jul 11, 2024

@paduszyk Hi, would it be possible for us to address #1119 (comment). I think we're really close to merging!

@Lee-W Lee-W added pr-status: wait-for-modification and removed pr-status: wait-for-review pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check labels Jul 11, 2024
@noirbizarre
Copy link
Member

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?) ?

@Lee-W
Copy link
Member

Lee-W commented Aug 21, 2024

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 Lee-W added the v4 label Aug 21, 2024
dependabot bot and others added 2 commits November 1, 2024 10:15
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.42 to 9.5.43.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.42...9.5.43)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@Lee-W Lee-W changed the base branch from master to v4 November 2, 2024 05:17
@Lee-W Lee-W changed the base branch from v4 to master November 2, 2024 05:23
@Lee-W Lee-W changed the base branch from master to v4 November 2, 2024 05:23
Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to change the test cases

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.

Default changelog titles for cz_conventional_commits
4 participants