feat(bump): support prereleases with a start offset

[ckagerer]

This PR solves #613

For special cases it may be necessary that prereleases cannot start with a 0, because the single characters are encoded in bytes. Here, consistent with the location for bugfixes, a 0 in the byte is interpreted as a release version. Therefore this commit introduces a generic option to change the start of the prerelease and also adapt it to such circumstances.

EXAMPLES

Previously:
0.3.0 -> PATCH beta-> 0.3.1b0

Now (with offset 0 == default):
0.3.0 -> PATCH beta-> 0.3.1b0

Now (with offset 1):
0.3.0 -> PATCH beta-> 0.3.1b1

Description

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

Expected behavior

Steps to Test This Pull Request

Additional context

[Lee-W]

Hi @ckagerer , thanks for your contribution and sorry for taking so long. The code looks good to me 🙌 But we might need your help to add some documentation and rebase the latest changes from the master branch.

[ckagerer]

Hi @Lee-W,
Thanks for your feedback and initial review.

I have rebased the latest master branch to my feature branch.

Where do you expect the documentation to be?
More in the code or is there more documentation?

Best regards
Christian

[Lee-W]

Hi @ckagerer thanks for the prompt update. I think we'll need to add the usage in https://github.com/commitizen-tools/commitizen/blob/master/docs/bump.md so that users know how to use

[ckagerer]

@Lee-W
Sure, I will be happy if my PR is integrated :)

I have already extended the documentation in config.md.

Should I also include a command line argument, or is it enough just to use the configuration?

[Lee-W]

@ckagerer It would be better if you could add the command line argument. Also, I notice we'll have to update the output of cz bump --help in https://github.com/commitizen-tools/commitizen/blob/master/docs/bump.md

[ckagerer]

@Lee-W
Command line argument has been added and I have extended the documentation.
What do you think?

[Lee-W]

Hi @ckagerer it looks great! I think our last step is to taking care of the CI failure.

[ckagerer]

Hey @Lee-W

Oh yes, I have ignored this so far because one of the unit tests fails locally on the master.

It seems to go wrong when installing with pip. Any experience with this?

I can try a poetry update to see if that helps.

[ckagerer]

No, there are no updates at all.
It fails with the "poetry install" but I have no idea why.

[codecov]

Codecov Report

Base: 97.92% // Head: 98.03% // Increases project coverage by +0.11% 🎉

Coverage data is based on head (c6fd959) compared to base (619e2d2).
Patch coverage: 87.87% of modified lines in pull request are covered.

❗ Current head c6fd959 differs from pull request most recent head dd2e075. Consider uploading reports for the commit dd2e075 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #614      +/-   ##
==========================================
+ Coverage   97.92%   98.03%   +0.11%     
==========================================
  Files          35       39       +4     
  Lines        1252     1682     +430     
==========================================
+ Hits         1226     1649     +423     
- Misses         26       33       +7     

Flag	Coverage Δ
unittests	98.03% <87.87%> (+0.11%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
commitizen/commands/init.py	87.93% <84.00%> (-3.74%)	⬇️
commitizen/__version__.py	100.00% <100.00%> (ø)
commitizen/commands/check.py	100.00% <100.00%> (ø)
commitizen/config/yaml_config.py	100.00% <100.00%> (ø)
commitizen/exceptions.py	100.00% <100.00%> (ø)
commitizen/changelog.py	99.43% <0.00%> (ø)
commitizen/__init__.py	100.00% <0.00%> (ø)
commitizen/bump.py	100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[Lee-W]

Do you have the error message?

[ckagerer]

@Lee-W

I think I read the message completely wrong :)

I ran the format script again and it was one line short. Now it should fit :)

[Lee-W]

Thanks @ckagerer for your contribution!

@woile I plan to merge this one by the end of this week. Let me know if you want to take a look.