René's URL Explorer Experiment

Title: fix(cargo_provider): support workspace virtual manifests by jcfangc · Pull Request #1733 · commitizen-tools/commitizen · GitHub

Open Graph Title: fix(cargo_provider): support workspace virtual manifests by jcfangc · Pull Request #1733 · commitizen-tools/commitizen

X Title: fix(cargo_provider): support workspace virtual manifests by jcfangc · Pull Request #1733 · commitizen-tools/commitizen

Description: Description Fix cargo_provider so cz bump works with Cargo workspace virtual manifests (root Cargo.toml containing [workspace] / [workspace.package] but no [package]) when workspace members inherit the version via package.version.workspace = true. Previously, cz bump could crash in commitizen/providers/cargo_provider.py with: NonExistentKey: Key "package" does not exist (virtual manifest has no [package]) TypeError: expected root version to be a string / unsafe assumptions around package.version shape This change makes the provider: Read/write the version from [workspace.package].version when present (fallback to [package].version for non-workspace manifests). When updating Cargo.lock: For non-workspace manifests, update the root package entry. For workspace virtual manifests, scan workspace.members (respecting exclude) and update lock entries for crates that declare package.version.workspace = true. Fixes #1732 Checklist I have read the contributing guidelines Added test coverage for the introduced behavior and edge cases Ran the test suite locally Manually tested the behavior (workspace virtual manifest + non-workspace crate) Updated documentation (not needed for this change) Note: the project uses uv / poe tasks (not Poetry). I ran the equivalent poe / uv-based test commands. Expected Behavior cz bump with version_provider = "cargo" should succeed for Cargo workspaces using a virtual manifest and centralized versioning in [workspace.package].version, without crashing. The workspace version should be updated, and Cargo.lock entries for crates inheriting the workspace version (package.version.workspace = true) should be updated safely. Non-workspace projects (root [package]) keep existing behavior. Steps to Test This Pull Request Manual test (workspace virtual manifest) Create a workspace root Cargo.toml: [workspace] members = ["crates/*"] [workspace.package] version = "1.0.0" edition = "2024" rust-version = "1.92" repository = "https://example.com/repo.git" Add a member crate crates/common-core/Cargo.toml: [package] name = "common-core" version.workspace = true edition.workspace = true rust-version.workspace = true repository.workspace = true Generate Cargo.lock once: cargo build Configure Commitizen: [tool.commitizen] name = "cz_conventional_commits" tag_format = "v$version" version_scheme = "semver" version_provider = "cargo" update_changelog_on_bump = true version_files = ["Cargo.toml:workspace.package.version"] Run: cz bump --yes Verify: [workspace.package].version is updated (e.g., 1.0.0 -> 1.1.0) Cargo.lock entries for workspace crates inheriting the version are updated no exceptions are raised Manual test (non-workspace manifest) Use a standard crate with root [package] and an existing Cargo.lock. Run cz bump --yes and verify the root package version in Cargo.lock is updated as before. Additional Context Reported in #1732. Targets workspace virtual manifests (no root [package]) and avoids unsafe assumptions about the TOML shape of version fields.

Open Graph Description: Description Fix cargo_provider so cz bump works with Cargo workspace virtual manifests (root Cargo.toml containing [workspace] / [workspace.package] but no [package]) when workspace members inherit...

X Description: Description Fix cargo_provider so cz bump works with Cargo workspace virtual manifests (root Cargo.toml containing [workspace] / [workspace.package] but no [package]) when workspace members inherit...

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

X: @github

direct link

Domain: patch-diff.githubusercontent.com

Links:

Viewport: width=device-width