Fix cz bump with custom type, scope and exclamation mark #774

jmattheis · 2023-06-26T14:45:18Z

Description

This change adds support for version bumping for custom types with a scope. Previously, a commit with the following message didn't increment the version.

$ git commit --allow-empty -m 'chore(scope)!: major change'
[master 0567ca4] chore(scope)!: major change
$ python ./commitizen/cli.py bump --dry-run
bump: version 3.5.2 → 3.5.2
tag to create: v3.5.2

[NO_COMMITS_TO_BUMP]
The commits found are not eligible to be bumped

Also, there is a minor bugfix in the bump command, that resulted in a wrongly calculated increment. (It's separated into a commit)

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

Not sure if I have to update the documentation, because I'd say it's the expected behavior from the conventional commit specification.

Expected behavior

See steps to reproduce.

Steps to Test This Pull Request

Add a commit

git commit --allow-empty -m 'chore(scope)!: major change'

Check that bump increments the major version

$ python ./commitizen/cli.py bump --dry-run
bump: version 3.5.2 → 4.0.0
tag to create: v4.0.0
increment detected: MAJOR

Additional context

Related to #673

codecov · 2023-06-26T14:48:13Z

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Files	Coverage Δ
commitizen/__version__.py	`100.00% <100.00%> (ø)`
commitizen/bump.py	`100.00% <100.00%> (ø)`
commitizen/cli.py	`94.20% <ø> (ø)`
commitizen/commands/bump.py	`97.66% <100.00%> (+0.01%)`	⬆️
commitizen/commands/commit.py	`98.64% <100.00%> (+0.05%)`	⬆️
commitizen/config/json_config.py	`100.00% <100.00%> (+6.45%)`	⬆️
commitizen/config/toml_config.py	`100.00% <100.00%> (ø)`
commitizen/config/yaml_config.py	`100.00% <100.00%> (ø)`
commitizen/defaults.py	`98.38% <100.00%> (-1.62%)`	⬇️
commitizen/providers/__init__.py	`100.00% <100.00%> (ø)`
... and 9 more

... and 1 file with indirect coverage changes

📢 Thoughts on this report? Let us know!.

evanjmg · 2023-09-21T13:36:58Z

Please merge this.

woile · 2023-10-11T05:16:29Z

Looks good! Could you rebase please?
@Lee-W what do you think?

Lee-W

mostly looks good to me. left one minor question

jmattheis · 2023-10-11T09:48:22Z

@Lee-W what's the minor question?

Lee-W · 2023-10-11T09:49:11Z

commitizen/defaults.py

@@ -104,7 +104,7 @@ class Settings(TypedDict, total=False):
 MINOR = "MINOR"
 PATCH = "PATCH"

-bump_pattern = r"^(((BREAKING[\-\ ]CHANGE|feat|fix|refactor|perf)(\(.+\))?(!)?)|\w+!):"
+bump_pattern = r"^((BREAKING[\-\ ]CHANGE|\w+)(\(.+\))?!?):"


Why do we remove feat|fix|refactor|perf)

As I understood commitizen allows you to define custom commit types, if we'd limit this to only feat|fix|refactor|perf then it wouldn't match for custom types.

Previously \w+! was included, but this didn't include the scope, the new regex is basically a simplified version that allows \w+! with a scope.

We can change it here. But we'll need to move the original value to https://github.com/commitizen-tools/commitizen/blob/master/commitizen/cz/conventional_commits/conventional_commits.py#L31.

Why? This change should be backwards compatible and it does fix a bug. chore! updates the major version but chore(scope)! does not.

yep, I think you're right. looks good to me. thanks for helping out!

Lee-W · 2023-10-11T09:50:41Z

@Lee-W what's the minor question?

https://github.com/commitizen-tools/commitizen/pull/774/files#r1354592313

did not succeeded sending it earlier 🤦‍♂️

Lee-W · 2023-10-11T13:55:00Z

I think after we fix the CI and the last comment. We're good to go

The old implementation wrongly set the `increment` variable to `None` if `increment = "PATCH"` and `new_increment = None`.

The regex didn't match the following commit with exclamation mark, and therefore didn't update the version. chore(deps)!: drop support for Python 3.9 The regex was simplified, because a lot groups were not needed.

Lee-W · 2023-10-12T13:39:12Z

@woile @noirbizarre this pr looks good to me. plan to merge it these days. please let me know if you want to take a look

Lee-W added the pr-status: wait-for-review label Jun 27, 2023

jmattheis force-pushed the bump_with_scope branch from fd77357 to 9af08f6 Compare October 11, 2023 06:46

Lee-W approved these changes Oct 11, 2023

View reviewed changes

Lee-W reviewed Oct 11, 2023

View reviewed changes

jmattheis added 2 commits October 12, 2023 08:38

fix(bump): version bumping

0c79e0a

The old implementation wrongly set the `increment` variable to `None` if `increment = "PATCH"` and `new_increment = None`.

fix(bump): add bump support with custom type + scope + exclamation mark

e3b7bd1

The regex didn't match the following commit with exclamation mark, and therefore didn't update the version. chore(deps)!: drop support for Python 3.9 The regex was simplified, because a lot groups were not needed.

jmattheis force-pushed the bump_with_scope branch from 9af08f6 to e3b7bd1 Compare October 12, 2023 06:39

Lee-W requested review from woile and noirbizarre October 12, 2023 13:38

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 Oct 12, 2023

woile approved these changes Oct 13, 2023

View reviewed changes

Lee-W merged commit 8f19b24 into commitizen-tools:master Oct 14, 2023

jmattheis deleted the bump_with_scope branch October 14, 2023 08:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix cz bump with custom type, scope and exclamation mark #774

Fix cz bump with custom type, scope and exclamation mark #774

jmattheis commented Jun 26, 2023

codecov bot commented Jun 26, 2023 •

edited

Loading

evanjmg commented Sep 21, 2023 •

edited

Loading

woile commented Oct 11, 2023

Lee-W left a comment

jmattheis commented Oct 11, 2023

Lee-W Oct 11, 2023

jmattheis Oct 11, 2023

Lee-W Oct 11, 2023

jmattheis Oct 12, 2023

Lee-W Oct 12, 2023

Lee-W commented Oct 11, 2023

Lee-W commented Oct 11, 2023

Lee-W commented Oct 12, 2023

Fix cz bump with custom type, scope and exclamation mark #774

Fix cz bump with custom type, scope and exclamation mark #774

Conversation

jmattheis commented Jun 26, 2023

Description

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

codecov bot commented Jun 26, 2023 • edited Loading

Codecov Report

evanjmg commented Sep 21, 2023 • edited Loading

woile commented Oct 11, 2023

Lee-W left a comment

Choose a reason for hiding this comment

jmattheis commented Oct 11, 2023

Lee-W Oct 11, 2023

Choose a reason for hiding this comment

jmattheis Oct 11, 2023

Choose a reason for hiding this comment

Lee-W Oct 11, 2023

Choose a reason for hiding this comment

jmattheis Oct 12, 2023

Choose a reason for hiding this comment

Lee-W Oct 12, 2023

Choose a reason for hiding this comment

Lee-W commented Oct 11, 2023

Lee-W commented Oct 11, 2023

Lee-W commented Oct 12, 2023

codecov bot commented Jun 26, 2023 •

edited

Loading

evanjmg commented Sep 21, 2023 •

edited

Loading