Conversation
| cz bump --yes | ||
| ``` | ||
|
|
||
| ### `--version-scheme` |
There was a problem hiding this comment.
I moved it to the bottom, to have a cohesive view of the cli options.
Eventually, version-scheme should have it's own section, where the differences between pep440 and semver are explained.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1924 +/- ##
=======================================
Coverage 97.99% 97.99%
=======================================
Files 60 60
Lines 2689 2691 +2
=======================================
+ Hits 2635 2637 +2
Misses 54 54 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Pull request overview
This PR updates Commitizen’s documentation structure/readability (addressing broken docs discoverability) and adjusts default versioning guidance/behavior toward semver2 for non-Python projects, alongside CI workflow modernization for bump/release automation.
Changes:
- Update docs navigation and config docs (including adding
version_provider/version_schemedetails and reorganizing sidebar entries). - Change the default version scheme selection for non-Python projects from
semvertosemver2(plus related test updates). - Revise GitHub Actions workflows to bump/tag/release via
cz+gh, and enable manual publish dispatch.
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_project_info.py | Updates expectations for default version_scheme to semver2. |
| tests/commands/test_bump_command.py | Formatting-only change to parametrized test ids lambda. |
| pyproject.toml | Updates metadata/deps and build settings; adjusts Commitizen tool config. |
| mkdocs.yml | Reorders configuration nav to improve discoverability. |
| docs/tutorials/github_actions.md | Adds a tip pointing to setup-cz. |
| docs/config/version_provider.md | Spacing/readability tweaks around configuration examples. |
| docs/config/option.md | Renames “Misc” to “General” and expands option descriptions. |
| docs/config/bump.md | Adds version_provider/version_scheme sections and details. |
| docs/commands/changelog.md | Improves option docs with config-file examples and wording. |
| docs/commands/bump.md | Relocates/rewrites --version-scheme docs and examples. |
| commitizen/project_info.py | Defaults non-Python projects to semver2. |
| commitizen/exceptions.py | Adds type annotations for exception attributes. |
| .github/workflows/pythonpublish.yml | Adds workflow_dispatch input and checks out specified ref. |
| .github/workflows/bumpversion.yml | Replaces action-based bump/release with explicit cz + gh steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| { name = "Tim Hsiung", email = "bear890707@gmail.com" }, | ||
| ] | ||
| license = { file = "LICENSE" } | ||
| license-files = ["LICENSE"] |
There was a problem hiding this comment.
license-files only controls which files get included in the sdist/wheel; it does not declare the project’s license in metadata. Since the previous license = { file = "LICENSE" } and the MIT classifier were removed, the package will no longer advertise a license on PyPI. Consider restoring the license field (or a license-expression) and optionally keep license-files for inclusion.
| license-files = ["LICENSE"] | |
| license-files = ["LICENSE"] | |
| license = { file = "LICENSE" } |
docs/tutorials/github_actions.md
Outdated
| > [!TIP] | ||
| > Check the new [setup-cz](https://github.com/marketplace/actions/setup-commitizen-cli) action, simple and with [examples](https://github.com/commitizen-tools/setup-cz/tree/main/examples) |
There was a problem hiding this comment.
MkDocs Material doesn’t support GitHub-style callouts (> [!TIP]) with the current mkdocs.yml extensions; it will render as a plain blockquote. Use the supported admonition syntax (!!! tip) (or enable a callout extension) so the tip renders correctly in the docs site.
| > [!TIP] | |
| > Check the new [setup-cz](https://github.com/marketplace/actions/setup-commitizen-cli) action, simple and with [examples](https://github.com/commitizen-tools/setup-cz/tree/main/examples) | |
| !!! tip | |
| Check the new [setup-cz](https://github.com/marketplace/actions/setup-commitizen-cli) action, simple and with [examples](https://github.com/commitizen-tools/setup-cz/tree/main/examples) |
Lee-W
left a comment
There was a problem hiding this comment.
a few question and comments. some suggestion from copilot seems to be correct
| - Default: `None` | ||
|
|
||
| Current version. Example: `"0.1.2"`. Required if you use `version_provider = "commitizen"`. | ||
| Example: `"0.1.2"`. |
There was a problem hiding this comment.
| Example: `"0.1.2"`. | |
| Example: `"0.1.2"`. |
Description
semver2duringinit(if not python)Checklist
Was generative AI tooling used to co-author this PR?
NO
Code Changes
uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
uv run poe doclocally to ensure the documentation pages renders correctlyExpected Behavior
Steps to Test This Pull Request
For the init:
mkdir -p /tmp/app && cd /tmp/appcz initAdditional Context