feat(bump): add functionality to write the next version to stdout #1195
Conversation
marcelblijleven
requested review from
Lee-W,
noirbizarre and
woile
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1195 +/- ##
==========================================
+ Coverage 97.33% 97.61% +0.27%
==========================================
Files 42 55 +13
Lines 2104 2516 +412
==========================================
+ Hits 2048 2456 +408
- Misses 56 60 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Adds a --get-next flag which determines the next version and writes it to stdout.
marcelblijleven
force-pushed
the
feature/add-get-next-flag
branch
from
76c6975 to
476be78
Compare
|
Thanks for the contribution! It looks good 🎉 . Could you add a comparison in the docs with Moreover, should this be part of the |
|
The idea looks great! I'll take a look this weekend when leading yet another dev sprint haha |
|
Thanks for the feedback, I've just added some additional information to the documentation. |
|
did not actually have the time to check it this weekend 🤦♂️ will try to do it these days! |
Lee-W
left a comment
Lee-W
left a comment
There was a problem hiding this comment.
I left a few nitpicks. non-blocking
| "--prerelease-offset cannot be combined with MANUAL_VERSION" | ||
| ) | ||
|
|
||
| if get_next: |
There was a problem hiding this comment.
Probably not required in this PR, but I feel we could move these validations out as a separate function 🤔
|
|
||
|
|
||
| @pytest.mark.usefixtures("tmp_commitizen_project") | ||
| def test_bump_get_next__changelog_is_not_allowed(mocker: MockFixture): |
There was a problem hiding this comment.
I feel we can combine these not_allowed test cases
|
I'm planning on merging it these days. But please do let me know if you want to take a look 🙂 @woile @noirbizarre |
Lee-W
added
pr-status: ready-to-merge
| "--changelog or --changelog-to-stdout is not allowed with --get-next" | ||
| ) | ||
| # Setting dry_run to prevent any unwanted changes to the repo or files | ||
| self.dry_run = True |
There was a problem hiding this comment.
Is self.dry_run used anywhere?
There was a problem hiding this comment.
There was a problem hiding this comment.
dry_run and self.dry_run are different objects here.
I have tested in my local environment. The assignment is redundant and the if dry_run: path is never hit if get_next is True because GetNextExit() is raised earlier.
4 participants
Adds a --get-next flag which determines the next version and writes it to stdout.
Description
The new
--get-nextflag can be used to determine the next version based on the available commits, and output it to stdout. This can be useful in CI, for example to determine the version for a preview build image.Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testExpected behavior
When provided, the
--get-nextflag makes commitizen behave similarly to--dry-run, it doesn't change any files and it doesn't create a tag. It determines the next version the same way a dry run does. It writes the next version to stdout, with no other output.The flag can't be used with
--changelog,--changelog-to-stdoutandMANUAL_VERSION, aNotAllowedexception will be raised if these options are provided together with--get-next.An example use case is assigning the output to a variable in CI.
Steps to Test This Pull Request
poetry run cz bump --get-nextpoetry run cz bump --dry-runAdditional context