NotificationsYou must be signed in to change notification settings
Fork304
Star3.2k

feat: update default changelog titles#1143

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

paduszyk wants to merge2 commits intocommitizen-tools:v5

base:v5

Choose a base branch

frompaduszyk:issue-1119

Open

feat: update default changelog titles#1143

paduszyk wants to merge2 commits intocommitizen-tools:v5frompaduszyk:issue-1119

Conversation

Copy link

Contributor

paduszyk commentedMay 24, 2024

Description

This updates the default titles of the changelog's sections inConventionalCommitsCz.

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.

paduszyk requested review fromLee-W,noirbizarre andwoile ascode owners

May 24, 2024 12:36

github-actionsbot added the pr-status: wait-for-review label

May 24, 2024

Copy link

codecovbot commentedMay 24, 2024•
edited
Loading

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 approved these changes

May 27, 2024

View reviewed changes

Lee-W added pr-status: ready-to-mergealmost 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

woile reviewed

May 27, 2024

View reviewed changes

tests/conftest.py

		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

ContributorAuthor

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 actualdefault_change_type_map when someone's tracing the test cases, they might be misled

github-actionsbot added the pr-status: wait-for-review label

Jul 2, 2024

Copy link

Member

Lee-W commentedJul 11, 2024

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

Lee-W added pr-status: wait-for-modification and removed pr-status: wait-for-review pr-status: ready-to-mergealmost ready to merge. just keep it for a few days for others to check labels

Jul 11, 2024

Copy link

Member

noirbizarre commentedAug 20, 2024

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

Copy link

Member

Lee-W commentedAug 21, 2024

I would flag this change as breaking as it means any user having a customchange_type_order with the defaultchange_type_map will see its changelog broken without a manual intervention (aka. updating thechange_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 added the v4 label

Aug 21, 2024

feat: update default changelog titles

34543d5

paduszyk force-pushed theissue-1119 branch frome2e928f to34543d5Compare

November 1, 2024 22:57

github-actionsbot added the pr-status: wait-for-review label

Nov 1, 2024

Lee-W changed the base branch frommaster tov4

November 2, 2024 05:17

Lee-W changed the base branch fromv4 tomaster

November 2, 2024 05:23

Lee-W changed the base branch frommaster tov4

November 2, 2024 05:23

Lee-W requested changes

Nov 2, 2024

View reviewed changes

Copy link

Member

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

Lee-W removed the pr-status: wait-for-review label

Nov 10, 2024

Lee-W removed the v4 label

Aug 24, 2025

Lee-W self-assigned this

Aug 24, 2025

Lee-W added this to the4.10.0 milestone

Aug 24, 2025

Copy link

ContributorAuthor

paduszyk commentedNov 6, 2025

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...