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

jcfangc · 2025-12-23T04:06:17Z

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 = trueedition.workspace = truerust-version.workspace = truerepository.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 = trueversion_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 cz bump crashes with version_provider=cargo on workspace virtual manifest (missing [package] / TypeError on version.workspace) #1732.
Targets workspace virtual manifests (no root [package]) and avoids unsafe assumptions about the TOML shape of version fields.

bearomorphism · 2025-12-26T09:41:06Z

Hi @jcfangc ,
Thank you for your contribution! Please follow the contribution guideline. You forget to run poetry format on the latest iteration.

jcfangc · 2025-12-31T01:24:46Z

Hi @jcfangc , Thank you for your contribution! Please follow the contribution guideline. You forget to run poetry format on the latest iteration.

Sorry about that—I’ll run poetry format and push an update asap.

codecov · 2026-01-04T09:23:44Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.01%. Comparing base (26e5d80) to head (6b955fc).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@ Coverage Diff @@## master #1733 +/- ##
==========================================
+ Coverage 97.98% 98.01% +0.02% 
==========================================
Files 60 60 Lines 2686 2714 +28 ==========================================
+ Hits 2632 2660 +28 
Misses 54 54

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jcfangc · 2026-01-04T10:00:24Z

When I first pulled the branch locally, I didn’t have uv.lock in the working tree, and poetry format isn’t a Poetry subcommand in my setup (Poetry 1.1.12 reports: “The command 'format' is not defined”).

Following the repo’s uv/poe workflow, I synced dependencies (needed uv sync --all-groups to make ruff available), then ran uv run poe format, and pushed the formatting update.

Just to clarify / FYI.

noirbizarre · 2026-01-05T01:23:33Z

I think it would be easier and cleaner to just rebase/squash on the current master.
You are not changing dependencies, so your PR should not touch the uv.lock file.
To avoid this side effect, run uv sync --frozen --all-groups instead of just uv sync --all-groups (uv default behavior is to check and update the lock).
Also, you might want to update your uv version, it is trying to downgrade the lock version so it might be outdated.

jcfangc · 2026-01-05T01:58:59Z

I think it would be easier and cleaner to just rebase/squash on the current master. You are not changing dependencies, so your PR should not touch the uv.lock file. To avoid this side effect, run uv sync --frozen --all-groups instead of just uv sync --all-groups (uv default behavior is to check and update the lock). Also, you might want to update your uv version, it is trying to downgrade the lock version so it might be outdated.

Thanks for the feedback.

I’ve rebased/squashed the branch on top of the current master and ensured the PR no longer touches lockfiles:

reverted/restored uv.lock and poetry.lock to match master (no lockfile changes in the PR diff now)

Going forward I’ll use uv sync --frozen --all-groups to avoid accidental lock updates, and I’ll also update my local uv to prevent lock format/version downgrades.

All checks are now green.

woile · 2026-01-05T08:53:14Z

The rebase did not succeed, only your commits should appear on "Commits".

On top of that, I wonder if #1715 (in-progress) addresses this issue, can you take a look? It also changes the read order, if there are no complaints about that I was planning on merging it

jcfangc · 2026-01-05T09:21:44Z

The rebase did not succeed, only your commits should appear on "Commits".
On top of that, I wonder if #1715 (in-progress) addresses this issue, can you take a look? It also changes the read order, if there are no complaints about that I was planning on merging it

Hi @woile, thanks for flagging #1715 — they are related but not the same.

fix: workspace member with fixed version #1715 focuses on two smaller cargo-provider behaviors:
1. ensuring we use the same precedence/order when reading vs writing the version between [package] and workspace metadata, and
2. clarifying/fixing the “fixed version for a workspace member” case: there is no workspace.version = "x.y.z" in Cargo spec; a member crate must use version = "x.y.z" even if it’s part of a workspace.
fix(cargo_provider): support workspace virtual manifests #1733 targets a broader and different failure mode: workspace virtual manifests (root Cargo.toml with [workspace] / [workspace.package] but no [package]). It:
1. prevents crashes when [package] is missing / when version.workspace shape appears,
2. reads/writes version from [workspace.package].version when present (fallback to [package].version for non-workspace manifests), and
3. updates Cargo.lock appropriately for virtual manifests by scanning workspace.members and updating lock entries for crates with package.version.workspace = true.

So #1715 does not address the virtual-manifest crash nor the lockfile update logic; #1733 does. The overlap is mostly around “precedence when both [package] and [workspace.package] exist”, which is a policy choice.

If you’d like to merge #1715 first, I can rebase #1733 on top of it and drop any overlapping hunks/tests. Alternatively, I can incorporate the #1715 precedence decision into #1733 so we end up with a single coherent behavior.

jcfangc · 2026-01-05T09:41:29Z

The rebase did not succeed, only your commits should appear on "Commits".
On top of that, I wonder if #1715 (in-progress) addresses this issue, can you take a look? It also changes the read order, if there are no complaints about that I was planning on merging it

I rebuilt the branch on top of current upstream/master by cherry-picking only my 4 commits (no merge commits).
The PR no longer touches any lockfiles (uv.lock / poetry.lock).

Could you please take another look? @woile

bearomorphism

Thank you for your contribution! Here are some feedbacks:

bearomorphism · 2026-01-05T13:52:48Z

+ t = _root_version_table(document)
+ v = t.get("version")
+ if not isinstance(v, str):
+ raise TypeError("expected root version to be a string")
+ return v


Please use more meaningful variable names. Do not use t or v.

jcfangc · 2026-01-07T02:18:25Z

Hi @bearomorphism @woile @noirbizarre @Lee-W — I’ve addressed the requested changes and force-pushed updates.

Fixed the review comments in cargo_provider.py, hardened parsing/lock updates, removed an unused type: ignore, and ran the formatter.
No uv.lock / poetry.lock changes; all checks are green.

Could you please re-review when you have a moment? Thanks.

- prefer [workspace.package] version with safe fallback to [package] - handle virtual workspace + version.workspace=true members when updating Cargo.lock - add regression tests for error/continue branches and workspace edge cases

noirbizarre

Just fix the naming concerns (t, v...) which makes maintenance harder when you hop from review to review and then it's good to merge (to me)

Lee-W

a few nits, but high-level idea looks good

Lee-W · 2026-02-04T02:14:38Z

-class CargoProvider(TomlProvider):
- """
- Cargo version management
+DictLike = dict[str, Any]


I'm not a fan of this 🤔 As it's actually a dict

Lee-W · 2026-02-04T02:15:47Z

+ t = _root_version_table(document)
+ v = t.get("version")
+ if not isinstance(v, str):
+ raise TypeError("expected root version to be a string")
+ return v


Suggested change
t=_root_version_table(document)
v=t.get("version")
ifnotisinstance(v, str):
raiseTypeError("expected root version to be a string")
returnv
table=_root_version_table(document)
version=table.get("version")
ifnotisinstance(version, str):
raiseTypeError("expected root version to be a string")
returnversion

Lee-W · 2026-02-04T02:16:10Z

+ return cast("DictLike", value) if hasattr(value, "get") else None
+
+
+def _root_version_table(doc: TOMLDocument) -> DictLike:


Suggested change
def_root_version_table(doc: TOMLDocument) ->DictLike:
def_extract_root_version_table(doc: TOMLDocument) ->DictLike:

Lee-W · 2026-02-04T02:16:47Z

+ root_pkg = _table_get(cargo_toml_content, "package")
+ if root_pkg is not None:


Suggested change
root_pkg=_table_get(cargo_toml_content, "package")
ifroot_pkgisnotNone:
if (root_pkg:=_table_get(cargo_toml_content, "package")) isnotNone:

Lee-W · 2026-02-04T02:19:41Z

+ return inheriting_member_names
+
+
+def _lock_set_versions(packages: Any, package_names: set[str], version: str) -> None:


Suggested change
def_lock_set_versions(packages: Any, package_names: set[str], version: str) ->None:
def_set_lock_versions(packages: Any, package_names: set[str], version: str) ->None:

Lee-W · 2026-02-04T02:21:41Z

+ workspace_table = _table_get(doc, "workspace")
+ if workspace_table is not None:


Suggested change
workspace_table=_table_get(doc, "workspace")
ifworkspace_tableisnotNone:
if (workspace_table:=_table_get(doc, "workspace")) isnotNone:

Lee-W · 2026-02-04T02:22:01Z

+ package_table = _table_get(doc, "package")
+ if package_table is None:


Suggested change
package_table=_table_get(doc, "package")
ifpackage_tableisNone:
if (package_table:=_table_get(doc, "package")) isNone:

Lee-W · 2026-02-04T02:22:36Z

+def _is_workspace_inherited_version(v: Any) -> bool:
+ return hasattr(v, "get") and cast("DictLike", v).get("workspace") is True


Suggested change
def_is_workspace_inherited_version(v: Any) ->bool:
returnhasattr(v, "get") andcast("DictLike", v).get("workspace") isTrue
def_is_workspace_inherited_version(version_table: Any) ->bool:
returnhasattr(version_table, "get") andcast("DictLike", version_table).get("workspace") isTrue

Lee-W · 2026-02-04T02:24:55Z

+ yield Path(match)
+
+
+def _workspace_inheriting_member_names(


Suggested change
def_workspace_inheriting_member_names(
def_collect_workspace_version_inheriting_members(

bearomorphism · 2026-02-09T12:03:23Z

conflict. converting this PR to draft

jcfangc requested review from Lee-W, noirbizarre and woile as code owners December 23, 2025 04:06

github-actionsBot added pr-status: wait-for-review type: bug labels Dec 23, 2025

bearomorphism added pr-status: wait-for-modification and removed pr-status: wait-for-review labels Dec 26, 2025

github-actionsBot added the pr-status: wait-for-review label Jan 4, 2026

jcfangc force-pushed the fix/cargo-workspace-virtual-manifest branch from a933a55 to c932fc0Compare January 5, 2026 01:42

jcfangc force-pushed the fix/cargo-workspace-virtual-manifest branch from d99d5af to 6bea1b9Compare January 5, 2026 09:40

bearomorphism requested changes Jan 5, 2026
View reviewed changes

bearomorphism removed the pr-status: wait-for-review label Jan 5, 2026

github-actionsBot added the pr-status: wait-for-review label Jan 6, 2026

jcfangc force-pushed the fix/cargo-workspace-virtual-manifest branch from 07c23f5 to 3d11e37Compare January 6, 2026 01:39

jcfangc requested a review from bearomorphism January 6, 2026 01:51

jcfangc force-pushed the fix/cargo-workspace-virtual-manifest branch 2 times, most recently from 8bad439 to df118dcCompare January 7, 2026 01:19

jcfangc force-pushed the fix/cargo-workspace-virtual-manifest branch 3 times, most recently from 5327c04 to 0eead00Compare January 14, 2026 01:27

jcfangc added 5 commits February 2, 2026 17:08

fix(cargo_provider): support workspace virtual manifests
bb819b3

style: run formatter
134f71c

fix(types): remove unused type ignore
8ec3d86

refactor(cargo_provider): improve readability and maintainability
6b955fc

jcfangc force-pushed the fix/cargo-workspace-virtual-manifest branch from 0eead00 to 6b955fcCompare February 2, 2026 09:08

noirbizarre reviewed Feb 3, 2026
View reviewed changes

Lee-W reviewed Feb 4, 2026
View reviewed changes

Lee-W removed the pr-status: wait-for-review label Feb 4, 2026

bearomorphism marked this pull request as draft February 9, 2026 12:03

bearomorphism mentioned this pull request May 25, 2026
fix(providers/cargo): don't crash on workspace member with fixed version #2002
Merged
10 tasks

-t=_root_version_table(document)
-v=t.get("version")
-ifnotisinstance(v, str):
-raiseTypeError("expected root version to be a string")
-returnv
+table=_root_version_table(document)
+version=table.get("version")
+ifnotisinstance(version, str):
+raiseTypeError("expected root version to be a string")
+returnversion

		return cast("DictLike", value) if hasattr(value, "get") else None


		def _root_version_table(doc: TOMLDocument) -> DictLike:

	def_root_version_table(doc: TOMLDocument) ->DictLike:
	def_extract_root_version_table(doc: TOMLDocument) ->DictLike:

		root_pkg = _table_get(cargo_toml_content, "package")
		if root_pkg is not None:

	root_pkg=_table_get(cargo_toml_content, "package")
	ifroot_pkgisnotNone:
	if (root_pkg:=_table_get(cargo_toml_content, "package")) isnotNone:

		return inheriting_member_names


		def _lock_set_versions(packages: Any, package_names: set[str], version: str) -> None:

	def_lock_set_versions(packages: Any, package_names: set[str], version: str) ->None:
	def_set_lock_versions(packages: Any, package_names: set[str], version: str) ->None:

		workspace_table = _table_get(doc, "workspace")
		if workspace_table is not None:

	workspace_table=_table_get(doc, "workspace")
	ifworkspace_tableisnotNone:
	if (workspace_table:=_table_get(doc, "workspace")) isnotNone:

		package_table = _table_get(doc, "package")
		if package_table is None:

	package_table=_table_get(doc, "package")
	ifpackage_tableisNone:
	if (package_table:=_table_get(doc, "package")) isNone:

		def _is_workspace_inherited_version(v: Any) -> bool:
		return hasattr(v, "get") and cast("DictLike", v).get("workspace") is True

-def_is_workspace_inherited_version(v: Any) ->bool:
-returnhasattr(v, "get") andcast("DictLike", v).get("workspace") isTrue
+def_is_workspace_inherited_version(version_table: Any) ->bool:
+returnhasattr(version_table, "get") andcast("DictLike", version_table).get("workspace") isTrue

	def_workspace_inheriting_member_names(
	def_collect_workspace_version_inheriting_members(

Uh oh!

Uh oh!

Conversation

jcfangc commented Dec 23, 2025• 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

Manual test (workspace virtual manifest)

Manual test (non-workspace manifest)

Additional Context

Uh oh!

bearomorphism commented Dec 26, 2025

Uh oh!

jcfangc commented Dec 31, 2025

Uh oh!

codecovBot commented Jan 4, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jcfangc commented Jan 4, 2026

Uh oh!

noirbizarre commented Jan 5, 2026

Uh oh!

jcfangc commented Jan 5, 2026

Uh oh!

woile commented Jan 5, 2026

Uh oh!

jcfangc commented Jan 5, 2026

Uh oh!

jcfangc commented Jan 5, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bearomorphism left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jcfangc commented Jan 7, 2026

Uh oh!

noirbizarre left a comment

Choose a reason for hiding this comment

Uh oh!

Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bearomorphism commented Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jcfangc commented Dec 23, 2025•
edited
Loading

codecovBot commented Jan 4, 2026•
edited
Loading

jcfangc commented Jan 5, 2026•
edited
Loading