Add crate name output to ensure-cargo-version action (#154)

* Add crate name output to ensure-cargo-version action

* Add coverage for crate name validation

* Fix lint issues in ensure-cargo-version tests

Author: leynos

.github/actions/ensure-cargo-version/README.md

@@ -16,6 +16,7 @@ Validate that the Git tag triggering a release workflow matches the version in o
 | ---- | ----------- |
 | `version` | Version extracted from the tag reference after removing the configured prefix. |
 | `crate-version` | Version read from the first manifest path provided (after resolution) after resolving workspace inheritance. |
+| `crate-name` | Package name read from the first manifest path provided (after resolution). |
 
 ## Usage
 

.github/actions/ensure-cargo-version/action.yml

@@ -46,3 +46,6 @@ outputs:
   crate-version:
     description: Version number declared in the first Cargo manifest.
     value: ${{ steps.verify.outputs['crate-version'] }}
+  crate-name:
+    description: Package name declared in the first Cargo manifest.
+    value: ${{ steps.verify.outputs['crate-name'] }}

.github/actions/ensure-cargo-version/scripts/ensure_cargo_version.py

@@ -27,9 +27,10 @@
 
 @dataclasses.dataclass(slots=True)
 class ManifestVersion:
-    """Version metadata extracted from a manifest."""
+    """Metadata extracted from a manifest."""
 
     path: Path
+    name: str
     version: str
 
 
@@ -59,7 +60,7 @@ def _resolve_paths(manifests: list[Path]) -> list[Path]:
 
 
 def _read_manifest_version(path: Path) -> ManifestVersion:
-    """Parse a manifest and return the discovered package version."""
+    """Parse a manifest and return the discovered package metadata."""
     try:
         with path.open("rb") as handle:
             data = tomllib.load(handle)
@@ -72,6 +73,11 @@ def _read_manifest_version(path: Path) -> ManifestVersion:
     if not isinstance(package, dict):
         raise ManifestError(path, "Manifest missing [package] table")
 
+    name = package.get("name")
+    if not isinstance(name, str) or not name.strip():
+        raise ManifestError(path, "Could not read package.name")
+    crate_name = name.strip()
+
     version = package.get("version")
     if isinstance(version, dict) and version.get("workspace") is True:
         workspace_manifest = _find_workspace_root(path.parent)
@@ -86,12 +92,12 @@ def _read_manifest_version(path: Path) -> ManifestVersion:
                 workspace_manifest,
                 "Workspace manifest missing [workspace.package].version",
             )
-        return ManifestVersion(path=path, version=workspace_version)
+        return ManifestVersion(path=path, name=crate_name, version=workspace_version)
 
     if not isinstance(version, str) or not version.strip():
         raise ManifestError(path, "Could not read package.version")
 
-    return ManifestVersion(path=path, version=version.strip())
+    return ManifestVersion(path=path, name=crate_name, version=version.strip())
 
 
 def _find_workspace_root(start_dir: Path) -> Path | None:
@@ -244,6 +250,7 @@ def main(
             )
 
     crate_version = manifest_versions[0].version if manifest_versions else ""
+    crate_name = manifest_versions[0].name if manifest_versions else ""
 
     if should_check_tag:
         if tag_version is None:  # pragma: no cover - defensive guard
@@ -271,6 +278,7 @@ def main(
         raise SystemExit(1)
 
     _write_output("crate-version", crate_version)
+    _write_output("crate-name", crate_name)
     manifest_list = ", ".join(_display_path(item.path) for item in manifest_versions)
     if should_check_tag:
         print(

.github/actions/ensure-cargo-version/scripts/tests/test_ensure_cargo_version.py

@@ -61,15 +61,53 @@ def test_coerce_bool_rejects_invalid_values() -> None:
         ensure._coerce_bool(value="not-a-boolean", parameter="check-tag")
 
 
-def _write_manifest(path: Path, version: str) -> None:
-    """Write a simple manifest declaring ``version`` to ``path``."""
+def _write_manifest(path: Path, version: str, *, name: str = "demo") -> None:
+    """Write a simple manifest declaring ``name`` and ``version`` to ``path``."""
     path.parent.mkdir(parents=True, exist_ok=True)
     path.write_text(
-        f"""[package]\nname = \"demo\"\nversion = \"{version}\"\n""",
+        f"""[package]\nname = \"{name}\"\nversion = \"{version}\"\n""",
         encoding="utf-8",
     )
 
 
+def _write_raw_manifest(path: Path, contents: str) -> None:
+    """Write a manifest with ``contents`` directly to ``path``."""
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(contents, encoding="utf-8")
+
+
+@pytest.mark.parametrize(
+    "manifest_contents",
+    [
+        '[package]\nversion = "1.2.3"\n',
+        '[package]\nname = ""\nversion = "1.2.3"\n',
+        '[package]\nname = "   "\nversion = "1.2.3"\n',
+    ],
+)
+def test_read_manifest_version_rejects_invalid_names(
+    tmp_path: Path, manifest_contents: str
+) -> None:
+    """A manifest must declare a non-empty ``package.name``."""
+    manifest_path = tmp_path / "Cargo.toml"
+    _write_raw_manifest(manifest_path, manifest_contents)
+
+    with pytest.raises(ensure.ManifestError, match=r"package\.name"):
+        ensure._read_manifest_version(manifest_path)
+
+
+def test_read_manifest_version_trims_whitespace_from_name(tmp_path: Path) -> None:
+    """Whitespace around the crate name should be ignored."""
+    manifest_path = tmp_path / "Cargo.toml"
+    _write_raw_manifest(
+        manifest_path,
+        '[package]\nname = " demo-crate "\nversion = "1.2.3"\n',
+    )
+
+    manifest_version = ensure._read_manifest_version(manifest_path)
+
+    assert manifest_version.name == "demo-crate"
+
+
 def test_main_skips_tag_comparison_when_disabled(
     monkeypatch: pytest.MonkeyPatch,
     tmp_path: Path,
@@ -89,6 +127,7 @@ def test_main_skips_tag_comparison_when_disabled(
 
     contents = output_file.read_text(encoding="utf-8").splitlines()
     assert "crate-version=1.2.4" in contents
+    assert "crate-name=demo" in contents
     assert "version=9.9.9" in contents
 
     captured = capsys.readouterr()
@@ -114,6 +153,7 @@ def test_main_with_disabled_tag_check_does_not_require_ref(
 
     contents = output_file.read_text(encoding="utf-8").splitlines()
     assert "crate-version=7.8.9" in contents
+    assert "crate-name=demo" in contents
     assert not any(line.startswith("version=") for line in contents)
 
     captured = capsys.readouterr()
@@ -160,8 +200,8 @@ def test_main_records_first_manifest_version_in_output(
     first_manifest = workspace / "Cargo.toml"
     second_manifest = workspace / "crates" / "other" / "Cargo.toml"
 
-    _write_manifest(first_manifest, "3.4.5")
-    _write_manifest(second_manifest, "9.9.9")
+    _write_manifest(first_manifest, "3.4.5", name="primary")
+    _write_manifest(second_manifest, "9.9.9", name="secondary")
 
     output_file = workspace / "outputs"
     monkeypatch.setenv("GITHUB_OUTPUT", str(output_file))
@@ -175,6 +215,7 @@ def test_main_records_first_manifest_version_in_output(
 
     contents = output_file.read_text(encoding="utf-8").splitlines()
     assert "crate-version=3.4.5" in contents
+    assert "crate-name=primary" in contents
     assert "version=3.4.5" in contents
 
     captured = capsys.readouterr()
@@ -200,7 +241,47 @@ def test_main_emits_crate_version_when_checking_tag(
 
     contents = output_file.read_text(encoding="utf-8").splitlines()
     assert "crate-version=4.5.6" in contents
+    assert "crate-name=demo" in contents
     assert "version=4.5.6" in contents
 
     captured = capsys.readouterr()
     assert "Release tag 4.5.6 matches" in captured.out
+
+
+@pytest.mark.parametrize(
+    "manifest_contents",
+    [
+        '[package]\nversion = "1.2.3"\n',
+        '[package]\nname = ""\nversion = "1.2.3"\n',
+        '[package]\nname = "   "\nversion = "1.2.3"\n',
+    ],
+)
+def test_main_aborts_when_crate_name_missing_or_blank(
+    monkeypatch: pytest.MonkeyPatch,
+    tmp_path: Path,
+    manifest_contents: str,
+) -> None:
+    """Invalid crate names should terminate the run with an error."""
+    workspace = tmp_path
+    manifest_path = workspace / "Cargo.toml"
+    _write_raw_manifest(manifest_path, manifest_contents)
+
+    output_file = workspace / "outputs"
+    monkeypatch.setenv("GITHUB_OUTPUT", str(output_file))
+    monkeypatch.setenv("GITHUB_WORKSPACE", str(workspace))
+
+    recorded_errors: list[tuple[str, str, Path | None]] = []
+
+    def record_error(title: str, message: str, *, path: Path | None = None) -> None:
+        recorded_errors.append((title, message, path))
+
+    monkeypatch.setattr(ensure, "_emit_error", record_error)
+
+    with pytest.raises(SystemExit) as excinfo:
+        ensure.main(manifests=[Path("Cargo.toml")], check_tag="false")
+
+    assert excinfo.value.code == 1
+    assert recorded_errors
+    error_titles = {title for title, _, _ in recorded_errors}
+    assert "Cargo.toml parse failure" in error_titles
+    assert any("package.name" in message for _, message, _ in recorded_errors)