feat(ConventionalCommitsCz): allow to override defaults from config #546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Closed

amitlevy21 wants to merge 1 commit into commitizen-tools:master from amitlevy21:cz-conventional-config

Closed

feat(ConventionalCommitsCz): allow to override defaults from config #546

amitlevy21 wants to merge 1 commit into commitizen-tools:master from amitlevy21:cz-conventional-config

Conversation

amitlevy21

Copy link

@amitlevy21 amitlevy21 commented Aug 3, 2022 •

edited

Loading

Before fixing tests and adding extra ones, I would like to receive
partial feedback about my changes to see if this aligns with the desired
code changes by maintainers.

As addressed on #535, when using customize commitizen, if we want to
customize a small attribute, we need to redefine all commitizens options
to make our custom class work.

For example:

diff --git a/cz.yaml b/cz.yaml
index f2e19a9..302e961 100644
--- a/cz.yaml
+++ b/cz.yaml
@@ -1,6 +1,18 @@
 commitizen:
 annotated_tag: true
 bump_message: 'bump: $current_version -> $new_version [skip ci]'
- name: cz_conventional_commits
+ name: cz_customize
 update_changelog_on_bump: true
 version: 0.11.0
+
+ customize:
+ bump_pattern: '^(fix|feat|docs|style|refactor|test|build|ci)'
+ bump_map:
+ fix: PATCH
+ feat: PATCH
+ docs: PATCH
+ style: PATCH
+ refactor: PATCH
+ test: PATCH
+ build: PATCH
+ ci: PATCH
diff --git a/t b/t
new file mode 100644
index 0000000..e69de29
diff --git a/t2 b/t2
new file mode 100644
index 0000000..e69de29

making the following change on a repo would cause an unexpected
behavior:

+ bash -c cz commit
Traceback (most recent call last):
 File "/home/amit/.local/bin/cz", line 8, in <module>
 sys.exit(main())
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/cli.py", line 382, in main
 args.func(conf, vars(args))()
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 74, in __call__
 m = self.prompt_commit_questions()
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in prompt_commit_questions
 for question in filter(lambda q: q["type"] == "list", questions):
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in <lambda>
 for question in filter(lambda q: q["type"] == "list", questions):
KeyError: 'type'

From my best understanding, this error happens because I didn't defined
question section in config, though I'm ok with using
ConventionalCommitsCz default ones.

This commit extends ConventionalCommitsCz to read from config and
fallbacks to defaults if some are not provided.

By adding this change, potentially customize commitizen can be
deprecated.

A warning message will be printed when using cz_customize

Closes #535.

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

@amitlevy21 amitlevy21 force-pushed the cz-conventional-config branch from a5ed888 to ed57fab Compare

August 3, 2022 12:56

amitlevy21

amitlevy21 commented

Aug 3, 2022

View reviewed changes

commitizen/cz/conventional_commits/conventional_commits.py Outdated Show resolved Hide resolved

commitizen/cz/conventional_commits/conventional_commits.py Show resolved Hide resolved

commitizen/cz/conventional_commits/conventional_commits.py Outdated Show resolved Hide resolved

Lee-W

Lee-W reviewed

Aug 7, 2022

View reviewed changes

Copy link

Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contributions!

I'm not sure whether we're to deprecate CustomizeCommitsCz now. We'll do it eventually. But I think it might be better for us to keep it but add a deprecation warning (e.g., we're going to deprecate it on 3.0) @woile What do you think?

commitizen/cz/conventional_commits/conventional_commits.py Outdated Show resolved Hide resolved

@amitlevy21 amitlevy21 force-pushed the cz-conventional-config branch 4 times, most recently from 2b903f9 to 440a7fa Compare

August 9, 2022 13:56

@amitlevy21 amitlevy21 force-pushed the cz-conventional-config branch from 440a7fa to 98c6fa1 Compare

August 31, 2022 10:15


 feat(ConventionalCommitsCz): allow to override defaults from config

6a993f7

As addressed on commitizen-tools#535, when using customize commitizen, if we want to
customize a small attribute, we need to redefine all commitizens options
to make our custom class work.
For example:
```diff
diff --git a/cz.yaml b/cz.yaml
index f2e19a9..302e961 100644
--- a/cz.yaml
+++ b/cz.yaml
@@ -1,6 +1,18 @@
 commitizen:
 annotated_tag: true
 bump_message: 'bump: $current_version -> $new_version [skip ci]'
- name: cz_conventional_commits
+ name: cz_customize
 update_changelog_on_bump: true
 version: 0.11.0
+
+ customize:
+ bump_pattern: '^(fix|feat|docs|style|refactor|test|build|ci)'
+ bump_map:
+ fix: PATCH
+ feat: PATCH
+ docs: PATCH
+ style: PATCH
+ refactor: PATCH
+ test: PATCH
+ build: PATCH
+ ci: PATCH
diff --git a/t b/t
new file mode 100644
index 0000000..e69de29
diff --git a/t2 b/t2
new file mode 100644
index 0000000..e69de29
```
making the following change on a repo would cause an unexpected
behavior:
```python
+ bash -c cz commit
Traceback (most recent call last):
 File "/home/amit/.local/bin/cz", line 8, in <module>
 sys.exit(main())
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/cli.py", line 382, in main
 args.func(conf, vars(args))()
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 74, in __call__
 m = self.prompt_commit_questions()
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in prompt_commit_questions
 for question in filter(lambda q: q["type"] == "list", questions):
 File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in <lambda>
 for question in filter(lambda q: q["type"] == "list", questions):
KeyError: 'type'
```
From my best understanding, this error happens because I didn't defined
question section in config, though I'm ok with using
ConventionalCommitsCz default ones.
This commit extends ConventionalCommitsCz to read from config and
fallbacks to defaults if some are not provided.
By adding this change, potentially customize commitizen can be
deprecated.
Closes commitizen-tools#535.

@amitlevy21 amitlevy21 force-pushed the cz-conventional-config branch from 98c6fa1 to 6a993f7 Compare

August 31, 2022 10:18

@amitlevy21

Copy link

Author

amitlevy21 commented Aug 31, 2022

@Lee-W Hi, made some changes and fixed tests, Can you take another look?

@Lee-W Lee-W added the pr-status: wait-for-review label

Sep 19, 2022

@Lee-W Lee-W self-assigned this

Sep 19, 2022

Lee-W

Lee-W reviewed

Jan 23, 2023

View reviewed changes

Copy link

Member

@Lee-W Lee-W left a comment •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @amitlevy21 , sorry for the super late reply. I just took a look and left some comments. Also, we might need your help to rebase from the latest master branch. Let me know if you have any though on it. Thanks!

commitizen/cz/base.py

if not self.config.settings.get("style"):

self.config.settings.update({"style": BaseCommitizen.default_style_config})

self.style = Style(self.config.settings.get("style", defaults.style))

self.bump_pattern: Optional[str] = self.config.settings.get(

Copy link

Member

@Lee-W Lee-W Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say the defaults.bump_pattern is something only for conventional commit that I want to move out from default and move it to conventional commit. Thus, I'd like to keep the default value of this as None

Copy link

Member

@Lee-W Lee-W Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This behavior should be applied to all the following default values which did not exist in BaseCommitizen

commitizen/cz/jira/jira.py

from commitizen.cz.base import BaseCommitizen

from commitizen.defaults import Questions

__all__ = ["JiraSmartCz"]

class JiraSmartCz(BaseCommitizen):

def __init__(self, config: BaseConfig):

super().__init__(config)

self.bump_map = None

Copy link

Member

@Lee-W Lee-W Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the values here is the ideal default values in BaseCommitizen and we should move the defaults to ConventionalCommitsCz

@Lee-W Lee-W added issue-status: wait-for-response pr-status: wait-for-modification and removed pr-status: wait-for-review labels

Jan 23, 2023

@Lee-W

Copy link

Member

Lee-W commented Aug 24, 2025

As this has no update since 2023 and there might be lots of conflicts, I'm going to close this one. Feel free to reopen it, if we still want this improvement in 🙂

@Lee-W Lee-W closed this

Aug 24, 2025

Labels

issue-status: wait-for-response pr-status: wait-for-modification

2 participants

@amitlevy21 @Lee-W

Uh oh!

feat(ConventionalCommitsCz): allow to override defaults from config #546

feat(ConventionalCommitsCz): allow to override defaults from config #546

Uh oh!

Conversation

@amitlevy21 amitlevy21 commented Aug 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

Uh oh!

Uh oh!

Uh oh!

Uh oh!

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

amitlevy21 commented Aug 31, 2022

Uh oh!

@Lee-W Lee-W left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

@Lee-W Lee-W Jan 23, 2023

Choose a reason for hiding this comment

Uh oh!

@Lee-W Lee-W Jan 23, 2023

Choose a reason for hiding this comment

Uh oh!

@Lee-W Lee-W Jan 23, 2023

Choose a reason for hiding this comment

Uh oh!

Lee-W commented Aug 24, 2025

Uh oh!

Uh oh!

@amitlevy21 amitlevy21 commented Aug 3, 2022 •

edited

Loading

@Lee-W Lee-W left a comment •

edited

Loading