Add `version_type` option to make version compatibly with semver #686

Apkawa · 2023-03-13T06:55:09Z

Description

I decided to use it in a rust project but cargo crashed when trying to use the prerelease versions.

I have added an optional setting that solves my problem for now.

`version_type`

Choose version type

pep440 - default version provider.
- prerelease - 1.0.1a0
- devrelease - 1.0.1dev0
- dev and pre - 1.0.1a0.dev0
semver - semver compatibly provider. Added "-" delimiter
- prerelease - 1.0.1-a0
- devrelease - 1.0.1-dev0
- dev and pre - 1.0.1-a0-dev0

TODO: renamed pre to long name, like alpha, beta, ..etc via additional option semver_long

[tool.commitizen]
version_type = "semver"

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

$ cz bump --check-consistency --no-verify --prerelease alpha --version-type=semver --dry-run
bump: version 0.1.0-a2 → 0.1.0-a3
tag to create: v0.1.0-a3

Additional context

#150

codecov · 2023-03-13T06:58:30Z

Codecov Report

Patch coverage: 94.11% and project coverage change: -0.19 ⚠️

Comparison is base (e34de55) 98.11% compared to head (f644bae) 97.92%.

Additional details and impacted files

@@            Coverage Diff             @@
##               v3     #686      +/-   ##
==========================================
- Coverage   98.11%   97.92%   -0.19%     
==========================================
  Files          41       42       +1     
  Lines        1855     1928      +73     
==========================================
+ Hits         1820     1888      +68     
- Misses         35       40       +5

Flag	Coverage Δ
unittests	`97.92% <94.11%> (-0.19%)`	⬇️

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

Impacted Files	Coverage Δ
commitizen/version_types.py	`90.74% <90.74%> (ø)`
commitizen/bump.py	`100.00% <100.00%> (ø)`
commitizen/changelog.py	`100.00% <100.00%> (ø)`
commitizen/cli.py	`94.11% <100.00%> (ø)`
commitizen/commands/bump.py	`98.14% <100.00%> (+0.02%)`	⬆️
commitizen/commands/changelog.py	`98.91% <100.00%> (+0.02%)`	⬆️
commitizen/defaults.py	`100.00% <100.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 in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

woile · 2023-03-13T07:09:21Z

Hey this is amazing! Thanks for taking the time to do it.

We have to think of a different name instead of version_provider, as we are using that on v3, for the file providing the version, see this

Apkawa · 2023-03-13T07:12:54Z

Hey this is amazing! Thanks for taking the time to do it.

We have to think of a different name instead of version_provider, as we are using that on v3, for the file providing the version, see this

hmm, maybe version_format?

woile · 2023-03-13T07:14:04Z

I was thinking of version_type, because version_format is the format used for the tag, e.g: if you want to have a tag v$version

commitizen/version_providers.py

tests/test_bump_find_version_provider.py

woile · 2023-03-13T07:25:47Z

Please also add the setting to config.md

woile · 2023-03-13T07:28:28Z

@Lee-W wanna take a look? I left some minor comments, but in general it looks good. Do you have any thoughts or thing we should we aware of?

I'm thinking, once we merge this, we should rebase v3.

woile · 2023-03-13T08:51:03Z

You can run ./scripts/format to fix the linting errors.

Apkawa · 2023-03-13T08:55:27Z

Oh, i checked only 3.9. Hmm

Apkawa · 2023-03-13T09:30:16Z

Error: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond. (api.github.com:443)

Please restart checks

Apkawa · 2023-03-13T10:45:06Z

Python package / python-check (3.7, windows-latest) (pull_request)

hm, blinked test?

Lee-W · 2023-03-13T15:48:10Z

I'm on a trip these 2 weeks and probably won't be able to review it.

AliSajid · 2023-04-09T21:52:32Z

Bumping this since this is really important for me.

Lee-W

@Apkawa This feature is amazing! Thanks for sending this awesome PR. I think we're almost ready to merge this one. I left a few minor comments. Let me know your thought.

Lee-W · 2023-04-16T05:44:53Z

commitizen/commands/changelog.py

@@ -50,6 +50,9 @@ def __init__(self, config: BaseConfig, args):
            "tag_format"
        )

+        version_type = self.config.settings.get("version_type")
+        self.version_type = version_type and version_types.types[version_type]


Should we capitalize types? i.e. version_types.TYPES[version_type]. Or maybe VERSION_TYPES might be an even better name?
It took me some time to find out version_type and version_type are different

Lee-W · 2023-04-16T05:51:03Z

commitizen/version_types.py

+
+
+class VersionProtocol(_Protocol):
+    def __init__(self, _version: typing.Union[Version, str]):


nitpick: I prefer from typing import Union, Optional a bit more

Lee-W · 2023-04-16T05:51:51Z

commitizen/version_types.py

+        parts.append(".".join(str(x) for x in version.release))
+
+        # Pre-release
+        if version.pre is not None:


nitpick: I prefer if not version.pre a bit more

Lee-W · 2023-04-16T05:54:56Z

docs/config.md

@@ -21,6 +21,7 @@
 | `use_shortcuts`            | `bool` | `false`                     | If enabled, commitizen will show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. [See more][shortcuts]                                                                                        |
 | `major_version_zero`       | `bool` | `false`                     | When true, breaking changes on a `0.x` will remain as a `0.x` version. On `false`, a breaking change will bump a `0.x` version to `1.0`. [major-version-zero]                                                                                        |
 | `prerelease_offset`        | `int`  | `0`                         | In special cases it may be necessary that a prerelease cannot start with a 0, e.g. in an embedded project the individual characters are encoded in bytes. This can be done by specifying an offset from which to start counting. [prerelease-offset] |
+| `version_type`             | `str`  | `pep440`                    | Select a version type from the following options [`pep440`, `semver`]. Useful for non python projects. [See more][version_type]                                                                                                                      |


nitpick: could you please change non python to non-python? Thanks!

Lee-W · 2023-04-16T06:01:53Z

tests/commands/test_bump_command.py

+    tag_exists = git.tag_exist("0.2.0-a0")
+    assert tag_exists is True
+
+    with open(tmp_version_file, "r") as f:


nitpick: do you think we could try the following?

for version_file in (tmp_version_file, tmp_commitizen_cfg_file): with open(version_file, "r") as f: assert "0.2.0-a0" in f.read()

If you agree with this, maybe we could try this technique in other tests in this PR as well

Lee-W · 2023-04-16T06:05:54Z

tests/commands/test_bump_command.py

+    # PRERELEASE
+    tmp_version_file = tmp_commitizen_project.join("__version__.py")
+    tmp_version_file.write("0.1.0")
+    tmp_commitizen_cfg_file = tmp_commitizen_project.join("pyproject.toml")
+    tmp_version_file_string = str(tmp_version_file).replace("\\", "/")
+    tmp_commitizen_cfg_file.write(
+        f"{tmp_commitizen_cfg_file.read()}\n"
+        f'version_files = ["{tmp_version_file_string}"]\n'
+        f'version_type = "semver"'
+    )
+
+    create_file_and_commit("feat: new user interface")


These setups are similar across different tests. Would it be possible for us to make them pytest fixtures?

Ok. I wrote a simple fixture returning a function with parameters ea7ac93#diff-e52e4ddd58b7ef887ab03c04116e676f6280b824ab7469d5d3080e5cba4f2128R30

Lee-W · 2023-04-16T06:08:58Z

tests/commands/test_changelog_command.py

+
+    out, _ = capsys.readouterr()
+
+    assert out == "## 0.3.0-a1 (2022-02-13)\n\n"


Should we unify the test way to use pytest-regressions as well?

Lee-W · 2023-04-16T06:09:48Z

tests/test_bump_find_version_type_semver.py

+
+
+@pytest.mark.parametrize(
+    "test_input,expected",


nitpick: please add an additional space i.e., test_input, expected

Apkawa · 2023-04-16T16:47:57Z

hmm. CI failed. but i didn't touch dependencies. Do I need to merge the master onto a branch?

Lee-W · 2023-04-17T01:47:58Z

hmm. CI failed. but i didn't touch dependencies. Do I need to merge the master onto a branch?

I just found out the root cause. It seems to relate to https://about.codecov.io/blog/message-regarding-the-pypi-package/. Could you please remove codecov = "^2.0" in pyproject.toml and try again? Thanks!

Lee-W · 2023-04-17T01:48:12Z

Other than that, everything looks good to me

woile · 2023-04-17T06:19:28Z

Could you point this to v3? v3 removes codecov dep and the tests are working fine.

I'll be working on v3 this week, and I would like this to be part of it 💪🏻

Apkawa · 2023-04-17T08:45:28Z

Ok. I fixed CI.

woile · 2023-04-17T08:49:36Z

Could you point the PR to the branch v3? thanks

Apkawa · 2023-04-17T09:50:27Z

Could you point the PR to the branch v3? thanks

Done. Failed not my test.

In #703 test_changelog_incremental_with_merge_prerelease need add @pytest.mark.freeze_time("2023-04-16") fixture.

i may fix it.

woile · 2023-04-17T16:20:11Z

Thanks, if you can also rebase your pr on top of V3 so we avoid the merge commit. I can fix the tests myself this week

Apkawa · 2023-04-17T19:10:22Z

Thanks, if you can also rebase your pr on top of V3 so we avoid the merge commit. I can fix the tests myself this week

Ok, i can do a rebase to one commit, but I'm afraid that if I do a force push, this PR will close.

woile · 2023-04-18T09:10:04Z

I'm asking for a rebase, not a squash. Otherwise the timeline will be dirty.
You can do something like:

git remote add upstream https://github.com/commitizen-tools/commitizen.git
git rebase upstream/v3

and then follow the instructions, fix the conflict and continue the rebase until it's done git rebase --continue

After that, you can do a force push and the PR will remain open

…ompatible with semver Signed-off-by: apkawa <apkawa@gmail.com>

… rename to `pep440` Signed-off-by: apkawa <apkawa@gmail.com>

Signed-off-by: apkawa <apkawa@gmail.com>

…rsion subclass Signed-off-by: apkawa <apkawa@gmail.com>

Signed-off-by: apkawa <apkawa@gmail.com>

…ersion_type=semver` option Signed-off-by: apkawa <apkawa@gmail.com>

… issue with freeze_time Signed-off-by: apkawa <apkawa@gmail.com>

Apkawa · 2023-04-18T19:22:04Z

I'm asking for a rebase, not a squash. Otherwise the timeline will be dirty. You can do something like:
git remote add upstream https://github.com/commitizen-tools/commitizen.git
git rebase upstream/v3
and then follow the instructions, fix the conflict and continue the rebase until it's done git rebase --continue

After that, you can do a force push and the PR will remain open

done, please check

woile · 2023-04-19T06:08:44Z

Thank you so much! 🎉

* feat(bump): version_provider=semver optional option to make version compatible with semver Signed-off-by: apkawa <apkawa@gmail.com> * refactor(bump): version_provider rename to version_type; `pep` option rename to `pep440` Signed-off-by: apkawa <apkawa@gmail.com> * docs(bump): add `version_type` info to config.md Signed-off-by: apkawa <apkawa@gmail.com> * refactor(bump): to use VersionProtocol interface instead packaging.Version subclass Signed-off-by: apkawa <apkawa@gmail.com> * test(bump): `VersionProtocol` workaround mypy for py==3.7 Signed-off-by: apkawa <apkawa@gmail.com> * fix(changelog): `changelog` command does not find version tag with `version_type=semver` option Signed-off-by: apkawa <apkawa@gmail.com> * refactor: minor review fixes * test(changelog): fix test_changelog_incremental_with_merge_prerelease issue with freeze_time Signed-off-by: apkawa <apkawa@gmail.com> --------- Signed-off-by: apkawa <apkawa@gmail.com>

woile reviewed Mar 13, 2023

View reviewed changes

commitizen/version_providers.py Outdated Show resolved Hide resolved

woile reviewed Mar 13, 2023

View reviewed changes

commitizen/version_providers.py Outdated Show resolved Hide resolved

woile reviewed Mar 13, 2023

View reviewed changes

tests/test_bump_find_version_provider.py Outdated Show resolved Hide resolved

Apkawa changed the title ~~Add version_provider option to make version compatibly with semver~~ Add version_type option to make version compatibly with semver Mar 13, 2023

noirbizarre mentioned this pull request Apr 8, 2023

feat(template): allow to override the template from cli, configuration and plugins #645

Merged

11 tasks

Lee-W approved these changes Apr 16, 2023

View reviewed changes

Lee-W added pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check wait-for-merge labels Apr 16, 2023

Apkawa changed the base branch from master to v3 April 17, 2023 09:06

Apkawa force-pushed the version_provider branch from 3c9c89c to 77c19c4 Compare April 18, 2023 18:37

Apkawa added 8 commits April 18, 2023 22:01

feat(bump): version_provider=semver optional option to make version c…

e19c729

…ompatible with semver Signed-off-by: apkawa <apkawa@gmail.com>

refactor(bump): version_provider rename to version_type; pep option…

c2a2a03

… rename to `pep440` Signed-off-by: apkawa <apkawa@gmail.com>

docs(bump): add version_type info to config.md

14d6ca9

Signed-off-by: apkawa <apkawa@gmail.com>

refactor(bump): to use VersionProtocol interface instead packaging.Ve…

54a9191

…rsion subclass Signed-off-by: apkawa <apkawa@gmail.com>

test(bump): VersionProtocol workaround mypy for py==3.7

389b85b

Signed-off-by: apkawa <apkawa@gmail.com>

fix(changelog): changelog command does not find version tag with `v…

af176ce

…ersion_type=semver` option Signed-off-by: apkawa <apkawa@gmail.com>

refactor: minor review fixes

59d1432

test(changelog): fix test_changelog_incremental_with_merge_prerelease…

f644bae

… issue with freeze_time Signed-off-by: apkawa <apkawa@gmail.com>

Apkawa force-pushed the version_provider branch from 77c19c4 to f644bae Compare April 18, 2023 19:09

woile merged commit c3d2c91 into commitizen-tools:v3 Apr 19, 2023

woile mentioned this pull request Apr 19, 2023

refactor: set default_install_hook_types #697

Merged

3 tasks

noirbizarre mentioned this pull request May 1, 2023

Feature: version schemes endpoint #733

Merged

4 tasks



		class VersionProtocol(_Protocol):
		def __init__(self, _version: typing.Union[Version, str]):


		out, _ = capsys.readouterr()

		assert out == "## 0.3.0-a1 (2022-02-13)\n\n"



		@pytest.mark.parametrize(
		"test_input,expected",

Add version_type option to make version compatibly with semver #686

Add version_type option to make version compatibly with semver #686

Conversation

Apkawa commented Mar 13, 2023 • edited Loading

Description

version_type

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

codecov bot commented Mar 13, 2023 • edited Loading

Codecov Report

woile commented Mar 13, 2023

Apkawa commented Mar 13, 2023

woile commented Mar 13, 2023

woile commented Mar 13, 2023

woile commented Mar 13, 2023

woile commented Mar 13, 2023

Apkawa commented Mar 13, 2023

Apkawa commented Mar 13, 2023

Apkawa commented Mar 13, 2023

Lee-W commented Mar 13, 2023

AliSajid commented Apr 9, 2023

Lee-W left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Apkawa commented Apr 16, 2023 • edited Loading

Lee-W commented Apr 17, 2023

Lee-W commented Apr 17, 2023

woile commented Apr 17, 2023

Apkawa commented Apr 17, 2023

woile commented Apr 17, 2023

Apkawa commented Apr 17, 2023 • edited Loading

woile commented Apr 17, 2023

Apkawa commented Apr 17, 2023

woile commented Apr 18, 2023

Apkawa commented Apr 18, 2023

woile commented Apr 19, 2023

Add `version_type` option to make version compatibly with semver #686

Add `version_type` option to make version compatibly with semver #686

Apkawa commented Mar 13, 2023 •

edited

Loading

`version_type`

codecov bot commented Mar 13, 2023 •

edited

Loading

Apkawa commented Apr 16, 2023 •

edited

Loading

Apkawa commented Apr 17, 2023 •

edited

Loading