feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum#1431

bearomorphism · 2025-05-17T17:26:06Z

Closes#129

Description

Please see bump_rule.py, bump.py, cz/base.py, version_scheme.py and commands/bump.py (~350 lines).
The rest 1000+ lines are just tests and renaming.

Rewrote the bump pattern matching mechanism to make the algorithm more strict and maintainable.
Maintained backward compatibility with CustomBumpRule.
~~Simplified code.~~
Added a new Enum class SemVerIncrement and replace MAJOR, MINOR, PATCH with the Enum.
Now Prerelease is Enum.
Simplify find_increment logic in SemVerIncrement.get_highest_by_messages.
- find_increment was the combination of 2 features: "finding the highest semantic version increment" and "parsing the semantic version increment from each git commit message".

Checklist

I have read the contributing guidelines

Code Changes

Add test cases to all the changes you introduce
Run poetry all locally to ensure this change passes linter check and tests
Manually test the changes:
- Verify the feature/bug fix works as expected in real-world scenarios
- Test edge cases and error conditions
- Ensure backward compatibility is maintained
- Document any manual testing steps performed
Update the documentation for the changes

Documentation Changes

Run poetry doc locally to ensure the documentation pages renders correctly

Expected Behavior

Steps to Test This Pull Request

Additional Context

codecov · 2025-05-17T17:37:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.97%. Comparing base (d968f26) to head (9c3421c).

Additional details and impacted files

@@ Coverage Diff @@## refactors #1431 +/- ## ============================================= + Coverage 97.92% 97.97% +0.04%  ============================================= Files 58 59 +1 Lines 2704 2770 +66 ============================================= + Hits 2648 2714 +66  Misses 56 56

Flag	Coverage Δ
unittests	`97.97% <100.00%> (+0.04%)`	⬆️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

commitizen/bump_rule.py

bearomorphism · 2025-05-17T20:32:30Z

commitizen/bump_rule.py

+self._BREAKING_CHANGE,
+"fix",
+"feat",
+"docs",
+"style",
+"refactor",
+"perf",
+"test",
+"build",
+"ci",


This makes the pattern matching more strict.

bearomorphism · 2025-05-17T20:34:49Z

commitizen/cz/base.py

+# TODO: deprecate these
 bump_pattern: str|None=None
 bump_map: dict[str, str] |None=None
 bump_map_major_version_zero: dict[str, str] |None=None


Not sure how to address these fields if we decide to check in the bump_rule change.

commitizen/bump_rule.py

bearomorphism · 2025-05-17T20:48:27Z

commitizen/bump.py

-ifnew_incrementisNone:
-logger.debug(
-f"no increment needed for '{found_keyword}' in '{message}'"
- )
-
-ifVERSION_TYPES.index(increment) <VERSION_TYPES.index(new_increment):
-logger.debug(
-f"increment detected is '{new_increment}' due to '{found_keyword}' in '{message}'"
- )
-increment=new_increment


I don't think we need these logs. The algorithm can be very simple as the current implementation of get_highest_by_messages

bearomorphism · 2025-05-18T08:40:54Z

The tests finally passed...

bearomorphism · 2025-05-19T09:18:55Z

commitizen/bump_rule.py

+ 'MINOR'
+ """
+returnSemVerIncrement.get_highest(
+get_increment(line)


I don't think we need these logs. The algorithm can be very simple as the current implementation of find_increment_by_callable
We can log the traces in get_increment though.

bearomorphism · 2025-05-19T09:36:50Z

commitizen/bump_rule.py

+try:
+ifret:=SemVerIncrement.get_highest(
+ (incrementforname, incrementinbump_map.items() ifm.group(name)),
+ ):
+returnret
+exceptIndexError:
+# Fallback to old school bump rule
+pass


This addresses the problem mentioned in #129
#129 (comment)

bearomorphism · 2025-05-19T15:50:29Z

Hope the doc string make it easier to review

commitizen/bump_rule.py

commitizen/defaults.py

Closescommitizen-tools#129

github-actionsbot added the pr-status: wait-for-review label May 17, 2025

bearomorphism force-pushed the bump-rule-interface branch from 566e8ec to 03aa596Compare May 17, 2025 17:35

bearomorphism changed the title ~~refactor(bump_rule): add bump_rule interface, DefaultBumpRule and its…~~refactor(bump_rule): strict check and reorganizeMay 17, 2025

bearomorphism force-pushed the bump-rule-interface branch from 4a0b84d to be7cb23Compare May 17, 2025 20:24

bearomorphism marked this pull request as ready for review May 17, 2025 20:26

bearomorphism requested review from Lee-W, noirbizarre and woile as code owners May 17, 2025 20:26

bearomorphism changed the title ~~refactor(bump_rule): strict check and reorganize~~fix(bump_rule): strict check and reorganizeMay 17, 2025

bearomorphism force-pushed the bump-rule-interface branch from deae807 to 88efb61Compare May 17, 2025 20:29

bearomorphism commented May 17, 2025
View reviewed changes

commitizen/bump_rule.py Outdated Show resolvedHide resolved

bearomorphism commented May 17, 2025
View reviewed changes

commitizen/bump_rule.py Outdated Show resolvedHide resolved

bearomorphism commented May 17, 2025
View reviewed changes

bearomorphism mentioned this pull request May 18, 2025
Semver refactor #1432
Closed
10 tasks

bearomorphism mentioned this pull request May 18, 2025
refactor: improve readability and fix typos #1416
Merged
10 tasks

bearomorphism force-pushed the bump-rule-interface branch from ecac37b to 83d6bdeCompare May 18, 2025 14:59

bearomorphism commented May 19, 2025
View reviewed changes

bearomorphism changed the title ~~fix(bump_rule): strict check and reorganize~~fix(bump_rule): add BumpRule, enum SemVerIncrement and PrereleaseMay 19, 2025

bearomorphism force-pushed the bump-rule-interface branch from 81d0457 to 2eaf52cCompare May 19, 2025 15:39

bearomorphism commented May 23, 2025
View reviewed changes

commitizen/bump_rule.py Outdated Show resolvedHide resolved

bearomorphism commented May 23, 2025
View reviewed changes

commitizen/bump_rule.py Outdated Show resolvedHide resolved

bearomorphism force-pushed the bump-rule-interface branch from 2eaf52c to 2e090b4Compare May 29, 2025 13:45

github-actionsbot added the type: bug label May 29, 2025

bearomorphism force-pushed the bump-rule-interface branch from 2e090b4 to ffdaa62Compare May 29, 2025 13:53

bearomorphism changed the title ~~fix(bump_rule): add BumpRule, enum SemVerIncrement and Prerelease~~feat(bump_rule): add BumpRule, VersionIncrement, Prerelease EnumMay 29, 2025

bearomorphism force-pushed the bump-rule-interface branch from ffdaa62 to 4f32a7fCompare May 31, 2025 18:11

bearomorphism changed the base branch from master to refactorsMay 31, 2025 18:11

github-actionsbot added the type: feature A new enhacement proposal label May 31, 2025

bearomorphism force-pushed the bump-rule-interface branch from 4f32a7f to 52acd60Compare May 31, 2025 18:13

Lee-W added this to the 4.9.0 milestone Jun 8, 2025

Lee-W force-pushed the refactors branch 2 times, most recently from baee83e to a9cd957Compare June 8, 2025 13:31

bearomorphism force-pushed the bump-rule-interface branch 2 times, most recently from fc31bee to 4279a25Compare June 8, 2025 15:42

bearomorphism commented Jun 8, 2025
View reviewed changes

commitizen/defaults.pyShow resolvedHide resolved

bearomorphism force-pushed the bump-rule-interface branch 2 times, most recently from 6e3caa5 to 8c7e2d3Compare June 8, 2025 15:48

feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum
9c3421c
Closescommitizen-tools#129

bearomorphism force-pushed the bump-rule-interface branch from 8c7e2d3 to 9c3421cCompare June 8, 2025 15:52

Lee-W deleted the branch commitizen-tools:refactorsJune 9, 2025 14:18

Lee-W closed this Jun 9, 2025

bearomorphism mentioned this pull request Jun 9, 2025
feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum #1518
Draft
10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum#1431

feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum #1431

bearomorphism commented May 17, 2025•
edited
Loading

Uh oh!

codecovbot commented May 17, 2025•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

bearomorphismMay 17, 2025

Uh oh!

bearomorphismMay 17, 2025

Uh oh!

Uh oh!

Uh oh!

bearomorphismMay 17, 2025•
edited
Loading

Uh oh!

bearomorphism commented May 18, 2025

Uh oh!

bearomorphismMay 19, 2025

Uh oh!

bearomorphismMay 19, 2025•
edited
Loading

Uh oh!

bearomorphism commented May 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum#1431

feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum #1431

Conversation

bearomorphism commented May 17, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Code Changes

Documentation Changes

Expected Behavior

Steps to Test This Pull Request

Additional Context

Uh oh!

codecovbot commented May 17, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

bearomorphismMay 17, 2025

Choose a reason for hiding this comment

Uh oh!

bearomorphismMay 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bearomorphismMay 17, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bearomorphism commented May 18, 2025

Uh oh!

bearomorphismMay 19, 2025

Choose a reason for hiding this comment

Uh oh!

bearomorphismMay 19, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bearomorphism commented May 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bearomorphism commented May 17, 2025•
edited
Loading

codecovbot commented May 17, 2025•
edited
Loading

bearomorphismMay 17, 2025•
edited
Loading

bearomorphismMay 19, 2025•
edited
Loading