feat(bump_rule): add BumpRule, VersionIncrement, Prerelease Enum #1518
Conversation
github-actions
bot
added
pr-status: wait-for-review
type: feature
bearomorphism
force-pushed
the
bump-rule-interface
branch
from
bb305ad to
8a6c84f
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v4-9-0-test #1518 +/- ##
==============================================
Coverage ? 98.39%
==============================================
Files ? 59
Lines ? 2737
Branches ? 0
==============================================
Hits ? 2693
Misses ? 44
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bearomorphism
force-pushed
the
bump-rule-interface
branch
from
8a6c84f to
8dd8d42
Compare
There was a problem hiding this comment.
This is definitely a great pull request that cleans up a lot of legacy code. However, we need to be cautious about maintaining backward compatibility. We can likely add some of the logic incrementally while keeping compatibility for a few minor versions. After that, we can bump the major version and remove the compatibility handling code.
commitizen/bump_rule.py
Outdated
|
|
||
|
|
||
| class ConventionalCommitBumpRule(BumpRule): | ||
| _BREAKING_CHANGE_TYPES = set(["BREAKING CHANGE", "BREAKING-CHANGE"]) |
There was a problem hiding this comment.
| _BREAKING_CHANGE_TYPES = set(["BREAKING CHANGE", "BREAKING-CHANGE"]) | |
| _BREAKING_CHANGE_TYPES = {"BREAKING CHANGE", "BREAKING-CHANGE"} |
commitizen/commands/bump.py
Outdated
| return bump.find_increment(commits, regex=bump_pattern, increments_map=bump_map) | ||
| return VersionIncrement.get_highest_by_messages( | ||
| (commit.message for commit in commits), | ||
| lambda x: self.cz.bump_rule.get_increment(x, is_major_version_zero), |
There was a problem hiding this comment.
this might be a breaking change for other non-standard czs
There was a problem hiding this comment.
We'll need a way to keep backward compatibility or move it to 5.0.0 instead (but that would be a pity since the PR looks os good)
| CHANGELOG_FORMAT = "markdown" | ||
|
|
||
| BUMP_PATTERN = r"^((BREAKING[\-\ ]CHANGE|\w+)(\(.+\))?!?):" | ||
| BUMP_MAP = OrderedDict( | ||
| BUMP_MAP = dict( |
There was a problem hiding this comment.
I guess we'll be able to remove them in the next major version?
bearomorphism
force-pushed
the
bump-rule-interface
branch
from
83c02fe to
650c720
Compare
bearomorphism
force-pushed
the
bump-rule-interface
branch
from
bb61b44 to
9cacfcb
Compare
|
Can we do squash rebase on this PR when it is ready for merge? |
yep, I can do that |
Related issue: #129
Original PR: #1431
Description
Please see
bump_rule.py,bump.py,cz/base.py,version_scheme.pyandcommands/bump.py(~350 lines).The rest 1000+ lines are just tests and renaming.
CustomBumpRule.Simplified code.SemVerIncrementand replaceMAJOR,MINOR,PATCHwith the Enum.Prereleaseis Enum.find_incrementlogic inSemVerIncrement.get_highest_by_messages.find_incrementwas the combination of 2 features: "finding the highest semantic version increment" and "parsing the semantic version increment from each git commit message".Checklist
Code Changes
poetry alllocally to ensure this change passes linter check and testsDocumentation Changes
poetry doclocally to ensure the documentation pages renders correctlyExpected Behavior
Steps to Test This Pull Request
Additional Context