[AAASM-4942] 🐛 (scripts): Make check_readme_version --check flag meaningful

[Chisanan232]

Description

scripts/check_readme_version.py accepted a --check flag but never read its
parsed value: parser.parse_args(argv) was discarded and audit() ran
unconditionally, so drift always returned exit 1 regardless of the flag. The flag
implied a mode that didn't exist. This makes it meaningful:

• --check (the CI-gate mode, unchanged for callers): exit 1 on drift.
• bare invocation: report drift to stderr but exit 0 — informational, non-gating.

The on-sync path is identical in both modes (prints the in-sync message, exits 0),
so the existing CI invocation (python scripts/check_readme_version.py --check in
readme-version-check.yml) and the CONTRIBUTING.md guidance keep working with no
caller changes.

Type of Change

• 🔧 Bug fix

Breaking Changes

• No

Related Issues

• Related JIRA ticket: AAASM-4942

Testing

• Unit tests added/updated

New test/unit/test_check_readme_version.py pins the two modes (loads the script
via importlib, monkeypatches _repo_root onto a temp tree): --check exits 1 on
drift, bare run exits 0 on drift, both exit 0 when in sync.

Manual validation:

• .venv/bin/python scripts/check_readme_version.py --check on the current tree → exit 0.
• Simulated-drift temp tree: --check → exit 1, bare → exit 0.
• ruff check + ruff format --check + mypy clean; new tests pass.

Checklist

• Code follows project style guidelines
• Self-review completed
• All tests passing

[Chisanan232]

🤖 Claude Code review

Scope — Two commits: the one-word-of-logic fix (scripts/check_readme_version.py) and its regression tests (test/unit/test_check_readme_version.py). No caller changes; verified all four invocations still pass --check and behave identically (CI readme-version-check.yml, CONTRIBUTING.md ×2, .claude/CLAUDE.md).

Root cause — parser.parse_args(argv) was called for validation only; the return value was dropped, so args.check was never consulted and drift always forced exit 1. The --check flag was inert — the exact no-op AAASM-4942 describes.

Fix — Capture args = parser.parse_args(argv) and gate the drift branch: return 1 if args.check else 0. On-sync behavior is unchanged in both modes. --check remains the CI gate; a bare run becomes an informational, non-failing report, which is what the help text always implied.

Risk — Low. The CI gate keeps failing on drift exactly as before (it passes --check); only the previously-unreachable non---check path changes, and it now honestly does something. No behavior change for any existing caller.

Validation — --check exits 1 on simulated drift / 0 in sync; bare run exits 0 either way. ruff check, ruff format --check, and strict mypy clean; 3 new unit tests pass.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud