|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import argparse |
| 6 | +import subprocess |
| 7 | +import sys |
| 8 | +import tomllib |
| 9 | +from pathlib import Path |
| 10 | + |
| 11 | + |
| 12 | +def parse_args() -> argparse.Namespace: |
| 13 | + parser = argparse.ArgumentParser( |
| 14 | + description="Verify Cargo.toml version is aligned with git tags." |
| 15 | + ) |
| 16 | + parser.add_argument( |
| 17 | + "--cargo-toml", |
| 18 | + default="Cargo.toml", |
| 19 | + help="Path to the Cargo.toml file to validate.", |
| 20 | + ) |
| 21 | + parser.add_argument( |
| 22 | + "--tag", |
| 23 | + help="Require Cargo.toml to match this exact git tag (for release workflows).", |
| 24 | + ) |
| 25 | + return parser.parse_args() |
| 26 | + |
| 27 | + |
| 28 | +def normalize_version(raw: str) -> str: |
| 29 | + value = raw.strip() |
| 30 | + return value[1:] if value.startswith("v") else value |
| 31 | + |
| 32 | + |
| 33 | +def parse_version(raw: str) -> tuple[int, ...]: |
| 34 | + normalized = normalize_version(raw) |
| 35 | + parts = normalized.split(".") |
| 36 | + if not parts or any(not part.isdigit() for part in parts): |
| 37 | + raise ValueError( |
| 38 | + f"Unsupported version '{raw}'. Expected dotted numeric versions like 0.5.26." |
| 39 | + ) |
| 40 | + return tuple(int(part) for part in parts) |
| 41 | + |
| 42 | + |
| 43 | +def read_cargo_version(cargo_toml: Path) -> str: |
| 44 | + with cargo_toml.open("rb") as handle: |
| 45 | + data = tomllib.load(handle) |
| 46 | + try: |
| 47 | + return str(data["package"]["version"]) |
| 48 | + except KeyError as error: |
| 49 | + raise KeyError(f"Missing [package].version in {cargo_toml}") from error |
| 50 | + |
| 51 | + |
| 52 | +def latest_release_tag() -> str | None: |
| 53 | + completed = subprocess.run( |
| 54 | + ["git", "tag", "--list", "v*", "--sort=-v:refname"], |
| 55 | + check=True, |
| 56 | + capture_output=True, |
| 57 | + text=True, |
| 58 | + ) |
| 59 | + for line in completed.stdout.splitlines(): |
| 60 | + candidate = line.strip() |
| 61 | + if candidate: |
| 62 | + return candidate |
| 63 | + return None |
| 64 | + |
| 65 | + |
| 66 | +def main() -> int: |
| 67 | + args = parse_args() |
| 68 | + cargo_toml = Path(args.cargo_toml) |
| 69 | + cargo_version = read_cargo_version(cargo_toml) |
| 70 | + cargo_tuple = parse_version(cargo_version) |
| 71 | + |
| 72 | + if args.tag: |
| 73 | + tag_version = normalize_version(args.tag) |
| 74 | + if cargo_version != tag_version: |
| 75 | + print( |
| 76 | + f"Cargo.toml version {cargo_version} does not match release tag {args.tag}.", |
| 77 | + file=sys.stderr, |
| 78 | + ) |
| 79 | + return 1 |
| 80 | + print(f"Cargo.toml version {cargo_version} matches release tag {args.tag}.") |
| 81 | + return 0 |
| 82 | + |
| 83 | + latest_tag = latest_release_tag() |
| 84 | + if latest_tag is None: |
| 85 | + print(f"Cargo.toml version {cargo_version} validated (no release tags found).") |
| 86 | + return 0 |
| 87 | + |
| 88 | + latest_tuple = parse_version(latest_tag) |
| 89 | + if cargo_tuple < latest_tuple: |
| 90 | + print( |
| 91 | + ( |
| 92 | + f"Cargo.toml version {cargo_version} is behind the latest tag {latest_tag}. " |
| 93 | + "Bump [package].version before merging." |
| 94 | + ), |
| 95 | + file=sys.stderr, |
| 96 | + ) |
| 97 | + return 1 |
| 98 | + |
| 99 | + print( |
| 100 | + f"Cargo.toml version {cargo_version} is aligned with latest tag {latest_tag}." |
| 101 | + ) |
| 102 | + return 0 |
| 103 | + |
| 104 | + |
| 105 | +if __name__ == "__main__": |
| 106 | + raise SystemExit(main()) |
0 commit comments