René's URL Explorer Experiment

Title: feat(cli): add cz --version back and add cz --report to separate them from cz version by bearomorphism · Pull Request #1798 · commitizen-tools/commitizen · GitHub

Open Graph Title: feat(cli): add cz --version back and add cz --report to separate them from cz version by bearomorphism · Pull Request #1798 · commitizen-tools/commitizen

X Title: feat(cli): add cz --version back and add cz --report to separate them from cz version by bearomorphism · Pull Request #1798 · commitizen-tools/commitizen

Description: Description Currently, all of cz version, cz version --commitizen, and cz version --report print the installed Commitizen version / system info. As we extend cz version to also report the project version (see #1785), it makes sense to extract those two installed-Commitizen / bug-report concerns out of the version subcommand and back into top-level flags: cz --version / cz -v — print the installed Commitizen version and exit. cz --report — print Commitizen version, Python version, and OS, intended for bug reports, and exit. The corresponding subcommand options are kept and emit a DeprecationWarning pointing at the new flags; they will be removed in v5. Closes part of #1785. Checklist I have read the contributing guidelines Was generative AI tooling used to co-author this PR? Yes (please specify the tool below) Generated-by: GitHub Copilot following the guidelines Code Changes Add test cases to all the changes you introduce Run uv run poe all locally to ensure this change passes linter check and tests Manually test the changes: Verify the feature/bug fix works as expected in real-world scenarios Test edge cases and error conditions Ensure backward compatibility is maintained (cz version --commitizen / cz version --report keep working with deprecation warnings) Document any manual testing steps performed (see below) Update the documentation for the changes Documentation Changes Run uv run poe doc locally to ensure the documentation pages renders correctly Check and fix any broken links (internal or external) Expected Behavior Invocation Behavior cz --version / cz -v Print installed Commitizen version. Takes precedence over any subcommand. cz --report Print Commitizen version, Python version, OS. Only takes effect when no subcommand is given. cz --report version Runs the version subcommand (top-level --report is a "no subcommand" flag — kept simple by design). cz version --commitizen Still works, emits DeprecationWarning pointing at cz --version. cz version --report Still works, emits DeprecationWarning pointing at cz --report. cz --invalid-arg Errors with argparse unrecognized arguments: --invalid-arg (previously silently fell through). cz (no args) Prints help — unchanged. cz invalidCommand argparse invalid choice error — unchanged. Steps to Test This Pull Request uv sync --frozen --group base --group test --group linters # New top-level flags uv run cz --version uv run cz -v uv run cz --report # Deprecated subcommand flags still work uv run cz version --commitizen # emits DeprecationWarning uv run cz version --report # emits DeprecationWarning # Unknown args now error properly uv run cz --invalid-arg # exits 13, prints argparse usage + "unrecognized arguments" # Regression tests uv run pytest tests/test_cli.py tests/commands/test_version_command.py uv run poe lint Additional Context Related: #1785. Reviewer feedback addressed in this PR: Empty tests/test_cli/test_invalid_command_py_*___invalid_arg_.txt baselines were a side effect of changing subcommands.required to False (needed so the new top-level flags work without a subcommand). parse_known_args() then silently swallowed --invalid-arg. Fixed by re-running parser.parse_args() when there is no subcommand and unknown args are present, so argparse's unrecognized arguments error reaches stderr; baselines regenerated for Python 3.10–3.14. The earlier suggestion to make cz --report version route to the top-level --report was intentionally left as-is: --report stays a simple "no subcommand" flag (per @woile's note: existing cz version --* options are kept until all the new features are out, then removed in v5).

Open Graph Description: Description Currently, all of cz version, cz version --commitizen, and cz version --report print the installed Commitizen version / system info. As we extend cz version to also report the project v...

X Description: Description Currently, all of cz version, cz version --commitizen, and cz version --report print the installed Commitizen version / system info. As we extend cz version to also report the project v...

Opengraph URL: https://github.com/commitizen-tools/commitizen/pull/1798

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width