Clarify what's a breaking change in commitizen

Description

#1435 (comment)

Possible Solution

No response

Additional context

No response

Additional context

No response

Relevant commit: 94c02b3

I'll probably do something like the following in defaults.py

# mymodule.py

import warnings

# ✅ Non-deprecated export
NEW_CONSTANT = "new value"

# ⚠️ Deprecated export (will warn on access)
_OLD_CONSTANT = "old value"

def __getattr__(name):
    if name == "OLD_CONSTANT":
        warnings.warn(
            "OLD_CONSTANT is deprecated and will be removed in a future version. Use NEW_CONSTANT instead.",
            category=DeprecationWarning,
            stacklevel=2,
        )
        return _OLD_CONSTANT
    raise AttributeError(f"module {__name__} has no attribute {name}")

fix(defaults): add non-capitalized default constants back and depreca…

I'll probably do something like the following in defaults.py

mymodule.py

import warnings

✅ Non-deprecated export

NEW_CONSTANT = "new value"

⚠️ Deprecated export (will warn on access)

_OLD_CONSTANT = "old value"

def getattr(name):
if name == "OLD_CONSTANT":
warnings.warn(
"OLD_CONSTANT is deprecated and will be removed in a future version. Use NEW_CONSTANT instead.",
category=DeprecationWarning,
stacklevel=2,
)
return _OLD_CONSTANT
raise AttributeError(f"module {name} has no attribute {name}")

Yep, PEP562 is definitely something we should use 🙂

fix(defaults): add non-capitalized default constants back and depreca…

I think the change in the following aspect should be viewed as a breaking changes.

How the cz command is used.
config used to be there, but removed
Change of BaseCommitizen, VersionProvider, VersionProtocol publice interface

Navigation Menu

Repository navigation

Clarify what's a breaking change in commitizen #1446

Description

Possible Solution

Additional context

Additional context

mymodule.py

✅ Non-deprecated export

⚠️ Deprecated export (will warn on access)

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Clarify what's a breaking change in commitizen #1446

Description

Description

Possible Solution

Additional context

Additional context

Activity

bearomorphism commented on May 22, 2025

bearomorphism commented on May 22, 2025

Lee-W commented on May 23, 2025

mymodule.py

✅ Non-deprecated export

⚠️ Deprecated export (will warn on access)

Lee-W commented on Aug 24, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions