feat(bump): functionality to add build-metadata to version string #949

xeor · 2023-12-28T23:58:50Z

Description

A way to add build-metadata from the cli using parameters, including being able to change them at as you want without disturbing the other version-logic in commitizen.

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

Should add additional functionality without disturbing anything.

Steps to Test This Pull Request

cz bump --build-metadata a.b.c
cz bump
cz bump --build-metadata alongmetadatastring
cz bump

Additional context

Closes: #945

codecov · 2023-12-29T00:01:18Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (120d514) 97.33% compared to head (916a0c6) 97.40%.
Report is 178 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #949      +/-   ##
==========================================
+ Coverage   97.33%   97.40%   +0.06%     
==========================================
  Files          42       55      +13     
  Lines        2104     2388     +284     
==========================================
+ Hits         2048     2326     +278     
- Misses         56       62       +6

Flag	Coverage Δ
unittests	`97.40% <100.00%> (+0.06%)`	⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

xeor · 2023-12-29T00:04:21Z

I tried to not "disturb" anything already implemented with "local version" already, but I had to wrap some changelog version logic inside a strip_local_version because versions diffed too much from eachothers. I think stripping out everything after + where I did is fine..?

woile · 2023-12-29T06:08:06Z

Looks good! I'll wait a bit more for reviews, probably next year I'll get to merge it

Lee-W

Sorry for taking so long. This looks great! Let's merge it

Lee-W · 2024-02-10T06:26:13Z

@xeor I just noticed there's some conflict. Could you please help us rebase it and resolve the conflict? Once it's done, I think we're good to merge it.

xeor · 2024-02-11T21:09:48Z

Tried to rebase, but there are some changes upstream that the formatter doesnt like and pre-commit hook changes.

diff --git a/commitizen/cz/base.py b/commitizen/cz/base.py
index 14d9e5a..d9bf5ea 100644
--- a/commitizen/cz/base.py
+++ b/commitizen/cz/base.py
@@ -37,9 +37,9 @@ class BaseCommitizen(metaclass=ABCMeta):
     change_type_order: list[str] | None = None

     # Executed per message parsed by the commitizen
-    changelog_message_builder_hook: None | (Callable[[dict, git.GitCommit], dict]) = (
-        None
-    )
+    changelog_message_builder_hook: None | (
+        Callable[[dict, git.GitCommit], dict]
+    ) = None

     # Executed only at the end of the changelog generation
     changelog_hook: Callable[[str, str | None], str] | None = None
diff --git a/commitizen/cz/exceptions.py b/commitizen/cz/exceptions.py
index d74f39a..2597b68 100644
--- a/commitizen/cz/exceptions.py
+++ b/commitizen/cz/exceptions.py
@@ -1,4 +1,6 @@
-class CzException(Exception): ...
+class CzException(Exception):
+    ...


-class AnswerRequiredError(CzException): ...
+class AnswerRequiredError(CzException):
+    ...
diff --git a/tests/test_changelog.py b/tests/test_changelog.py
index 879443f..8aef10a 100644
--- a/tests/test_changelog.py
+++ b/tests/test_changelog.py
@@ -1298,9 +1298,9 @@ def test_render_changelog_with_changelog_message_builder_hook(
     gitcommits, tags, any_changelog_format: ChangelogFormat
 ):
     def changelog_message_builder_hook(message: dict, commit: git.GitCommit) -> dict:
-        message["message"] = (
-            f"{message['message']} [link](github.com/232323232) {commit.author} {commit.author_email}"
-        )
+        message[
+            "message"
+        ] = f"{message['message']} [link](github.com/232323232) {commit.author} {commit.author_email}"
         return message

     parser = ConventionalCommitsCz.commit_parser
diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py
index 20a17b3..9f3556f 100644
--- a/tests/test_cz_customize.py
+++ b/tests/test_cz_customize.py
@@ -498,8 +498,7 @@ def test_answer_unicode(config_with_unicode):
     }
     message = cz.message(answers)
     assert (
-        message
-        == "✨ feature: this feature enables customization through a config file"
+        message == "✨ feature: this feature enables customization through a config file"
     )

     cz = CustomizeCommitsCz(config_with_unicode)
@@ -575,8 +574,7 @@ def test_commit_parser(config):
 def test_commit_parser_unicode(config_with_unicode):
     cz = CustomizeCommitsCz(config_with_unicode)
     assert (
-        cz.commit_parser
-        == "^(?P<change_type>✨ feature|🐛 bug fix):\\s(?P<message>.*)?"
+        cz.commit_parser == "^(?P<change_type>✨ feature|🐛 bug fix):\\s(?P<message>.*)?"
     )

shall I ignore them or wait for you guys to fix the formatting upstream?

Lee-W · 2024-02-13T03:06:35Z

Tried to rebase, but there are some changes upstream that the formatter doesnt like and pre-commit hook changes.

diff --git a/commitizen/cz/base.py b/commitizen/cz/base.py
index 14d9e5a..d9bf5ea 100644
--- a/commitizen/cz/base.py
+++ b/commitizen/cz/base.py
@@ -37,9 +37,9 @@ class BaseCommitizen(metaclass=ABCMeta):
     change_type_order: list[str] | None = None

     # Executed per message parsed by the commitizen
-    changelog_message_builder_hook: None | (Callable[[dict, git.GitCommit], dict]) = (
-        None
-    )
+    changelog_message_builder_hook: None | (
+        Callable[[dict, git.GitCommit], dict]
+    ) = None

     # Executed only at the end of the changelog generation
     changelog_hook: Callable[[str, str | None], str] | None = None
diff --git a/commitizen/cz/exceptions.py b/commitizen/cz/exceptions.py
index d74f39a..2597b68 100644
--- a/commitizen/cz/exceptions.py
+++ b/commitizen/cz/exceptions.py
@@ -1,4 +1,6 @@
-class CzException(Exception): ...
+class CzException(Exception):
+    ...


-class AnswerRequiredError(CzException): ...
+class AnswerRequiredError(CzException):
+    ...
diff --git a/tests/test_changelog.py b/tests/test_changelog.py
index 879443f..8aef10a 100644
--- a/tests/test_changelog.py
+++ b/tests/test_changelog.py
@@ -1298,9 +1298,9 @@ def test_render_changelog_with_changelog_message_builder_hook(
     gitcommits, tags, any_changelog_format: ChangelogFormat
 ):
     def changelog_message_builder_hook(message: dict, commit: git.GitCommit) -> dict:
-        message["message"] = (
-            f"{message['message']} [link](github.com/232323232) {commit.author} {commit.author_email}"
-        )
+        message[
+            "message"
+        ] = f"{message['message']} [link](github.com/232323232) {commit.author} {commit.author_email}"
         return message

     parser = ConventionalCommitsCz.commit_parser
diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py
index 20a17b3..9f3556f 100644
--- a/tests/test_cz_customize.py
+++ b/tests/test_cz_customize.py
@@ -498,8 +498,7 @@ def test_answer_unicode(config_with_unicode):
     }
     message = cz.message(answers)
     assert (
-        message
-        == "✨ feature: this feature enables customization through a config file"
+        message == "✨ feature: this feature enables customization through a config file"
     )

     cz = CustomizeCommitsCz(config_with_unicode)
@@ -575,8 +574,7 @@ def test_commit_parser(config):
 def test_commit_parser_unicode(config_with_unicode):
     cz = CustomizeCommitsCz(config_with_unicode)
     assert (
-        cz.commit_parser
-        == "^(?P<change_type>✨ feature|🐛 bug fix):\\s(?P<message>.*)?"
+        cz.commit_parser == "^(?P<change_type>✨ feature|🐛 bug fix):\\s(?P<message>.*)?"
     )

shall I ignore them or wait for you guys to fix the formatting upstream?

hmmm... just ignore the formating issue and let me resolve it 😄

xeor · 2024-02-15T21:21:45Z

I think it is ready now @Lee-W . There are 3 pr-status labels, but I guess it's back in the queue? :)

Lee-W · 2024-02-16T01:36:20Z

@xeor It seems there's a conflict between this branch and the main branch. We might need your help on that. You can do it with the following commands.

git remote add upstream https://github.com/commitizen-tools/commitizen
git checkout master
git pull upstream master
git checkout issue-945
git rebase -i master

xeor · 2024-02-16T20:16:28Z

Thanks @Lee-W , I think it is finally mergable 👍

Lee-W · 2024-02-17T03:21:21Z

Thanks @Lee-W , I think it is finally mergable 👍

Awesome work! Let's merge it!

xeor requested review from woile, Lee-W and noirbizarre as code owners December 28, 2023 23:58

github-actions bot added the pr-status: wait-for-review label Dec 28, 2023

woile approved these changes Dec 29, 2023

View reviewed changes

Lee-W approved these changes Feb 10, 2024

View reviewed changes

Lee-W added pr-status: wait-for-modification pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check and removed pr-status: wait-for-review labels Feb 10, 2024

github-actions bot added the pr-status: wait-for-review label Feb 15, 2024

Lee-W approved these changes Feb 16, 2024

View reviewed changes

Lee-W removed the pr-status: wait-for-review label Feb 16, 2024

xeor force-pushed the issue-945 branch from 8ab976c to be5b57b Compare February 16, 2024 14:32

github-actions bot added the pr-status: wait-for-review label Feb 16, 2024

xeor force-pushed the issue-945 branch from be5b57b to 9aa6a73 Compare February 16, 2024 14:38

feat(bump): functionality to add build-metadata to version string

916a0c6

xeor force-pushed the issue-945 branch from 9aa6a73 to 916a0c6 Compare February 16, 2024 15:07

Lee-W approved these changes Feb 17, 2024

View reviewed changes

Lee-W merged commit 981065e into commitizen-tools:master Feb 17, 2024
18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(bump): functionality to add build-metadata to version string #949

feat(bump): functionality to add build-metadata to version string #949

xeor commented Dec 28, 2023 •

edited by Lee-W

Loading

codecov bot commented Dec 29, 2023 •

edited

Loading

xeor commented Dec 29, 2023

woile commented Dec 29, 2023

Lee-W left a comment

Lee-W commented Feb 10, 2024

xeor commented Feb 11, 2024

Lee-W commented Feb 13, 2024

xeor commented Feb 15, 2024

Lee-W commented Feb 16, 2024

xeor commented Feb 16, 2024

Lee-W commented Feb 17, 2024

feat(bump): functionality to add build-metadata to version string #949

feat(bump): functionality to add build-metadata to version string #949

Conversation

xeor commented Dec 28, 2023 • edited by Lee-W Loading

Description

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

codecov bot commented Dec 29, 2023 • edited Loading

Codecov Report

xeor commented Dec 29, 2023

woile commented Dec 29, 2023

Lee-W left a comment

Choose a reason for hiding this comment

Lee-W commented Feb 10, 2024

xeor commented Feb 11, 2024

Lee-W commented Feb 13, 2024

xeor commented Feb 15, 2024

Lee-W commented Feb 16, 2024

xeor commented Feb 16, 2024

Lee-W commented Feb 17, 2024

xeor commented Dec 28, 2023 •

edited by Lee-W

Loading

codecov bot commented Dec 29, 2023 •

edited

Loading