VersionIncrement related cleanup #1777

Activity

1. bearomorphism

   added

   type: featureA new enhacement proposalA new enhacement proposal

   on Jan 6, 2026
2. github-actions

   added

   issue-status: needs-triage

   on Jan 6, 2026
3. bearomorphism

   self-assigned this

   on Jan 6, 2026
4. Lee-W commented on Jan 6, 2026

   

   Lee-W

   on Jan 6, 2026

   Member

   More actions

   Replace ['MAJOR', 'MINOR', 'PATCH'] with IntEnums

   Why do we need to do it?
5. bearomorphism commented on Jan 7, 2026

   

   bearomorphism

   on Jan 7, 2026

   CollaboratorAuthor

   More actions

   Replace ['MAJOR', 'MINOR', 'PATCH'] with IntEnums

   Why do we need to do it?

   Commitizen often has to determine which Increment is actually using. For example,

   commitizen/commitizen/bump.py

   Line 53 in d1f8bf0

   if VERSION_TYPES.index(increment) < VERSION_TYPES.index(new_increment):

   But comparing the index is a bit unclear and hard to maintain.

   I have implemented it in #1518 a few months ago (but now there are too many conflicts, so I'd prefer to start over and probably split it into several smaller PRs). The function find_increments can be redesigned in a way clearer way:

   1. Extract the subject (first line) of each commit in the git rev range
   2. Map each commit subject to a VersionIncrement, so we have a collection of VersionIncrements
   3. Take the maximum of the collection. (Supposing MAJOR > MINOR > PATCH > NONE)

   The implementation of VersionIncrement can be found in #1724.
6. bearomorphism commented on May 9, 2026

   

   bearomorphism

   on May 9, 2026

   CollaboratorAuthor

   More actions

   Replacing the MAJOR/MINOR/PATCH string constants in commitizen/defaults.py and commitizen/bump.py with the existing VersionIncrement IntEnum at commitizen/version_increment.py is a cross-cutting refactor (bump.py, commands/bump.py, commands/version.py, cli.py, plus the entire test suite that compares against literal strings). It's also a breaking change for any external code that imports MAJOR/MINOR/PATCH and compares with ==.

   Best done as part of the v5 cleanup so the deprecation doesn't have to span a 4.x release. Surfaced via the round-2 triage in #1965 — proposing this be tracked under #1481 (v5).