ausboss
f2f69afc97
shields.io's dynamic TOML badge reads the version straight out of pyproject.toml on main at view time, so the badge cannot go stale by construction - no third version string to bump. Preflight check 3 flips from comparing a hardcoded number to guarding the mechanism: the dynamic badge must be present and a hardcoded release-X.Y.Z badge fails the check. AGENTS.md's release step 1 goes back to two version strings.
92 lines
3.2 KiB
Python
92 lines
3.2 KiB
Python
#!/usr/bin/env python
|
|
"""Release preflight checks - no ComfyUI required.
|
|
|
|
Run from anywhere: python scripts/release_preflight.py
|
|
|
|
Checks:
|
|
1. pyproject.toml has no UTF-8 BOM. tomllib rejects a BOM, and both
|
|
ComfyUI-Manager and the Comfy Registry parse the file with it, so a
|
|
BOM breaks installs silently.
|
|
2. AUSBOSS_JS_VERSION in js/shared/index.mjs equals the pyproject
|
|
version, so the stale-browser warning never fires on a fresh install.
|
|
3. The README release badge is the DYNAMIC shields.io kind - it reads
|
|
the version out of pyproject.toml on main at view time, so it can
|
|
never go stale (a hardcoded badge sat at 1.0.0 through two releases).
|
|
The check guards against someone swapping a static badge back in.
|
|
|
|
Exit code 0 = ready to release, 1 = problems printed below.
|
|
"""
|
|
|
|
import pathlib
|
|
import re
|
|
import sys
|
|
|
|
ROOT = pathlib.Path(__file__).resolve().parent.parent
|
|
errors = []
|
|
|
|
# --- 1. pyproject.toml is BOM-free and carries a version ---------------------
|
|
pyproject_version = None
|
|
try:
|
|
raw = (ROOT / "pyproject.toml").read_bytes()
|
|
except OSError as exc:
|
|
errors.append(f"could not read pyproject.toml: {exc}")
|
|
raw = b""
|
|
|
|
if raw.startswith(b"\xef\xbb\xbf"):
|
|
errors.append("pyproject.toml starts with a UTF-8 BOM; save it without one")
|
|
|
|
match = re.search(rb'^version\s*=\s*"([^"]+)"', raw, re.MULTILINE)
|
|
if match:
|
|
pyproject_version = match.group(1).decode("ascii", "replace")
|
|
else:
|
|
errors.append('pyproject.toml has no version = "..." line')
|
|
|
|
# --- 2. the frontend version constant matches --------------------------------
|
|
js_version = None
|
|
try:
|
|
shared = (ROOT / "js" / "shared" / "index.mjs").read_text(encoding="utf-8")
|
|
js_match = re.search(r'AUSBOSS_JS_VERSION\s*=\s*"([^"]+)"', shared)
|
|
if js_match:
|
|
js_version = js_match.group(1)
|
|
else:
|
|
errors.append("js/shared/index.mjs does not define AUSBOSS_JS_VERSION")
|
|
except OSError as exc:
|
|
errors.append(f"could not read js/shared/index.mjs: {exc}")
|
|
|
|
if pyproject_version and js_version and pyproject_version != js_version:
|
|
errors.append(
|
|
f"version mismatch: pyproject.toml says {pyproject_version} but "
|
|
f"AUSBOSS_JS_VERSION is {js_version}"
|
|
)
|
|
|
|
# --- 3. the README release badge stays dynamic -------------------------------
|
|
DYNAMIC_BADGE = (
|
|
"img.shields.io/badge/dynamic/toml"
|
|
"?url=https%3A%2F%2Fraw.githubusercontent.com%2Fausboss%2FComfyUI-AusBoss"
|
|
"%2Fmain%2Fpyproject.toml&query=%24.project.version"
|
|
)
|
|
try:
|
|
readme = (ROOT / "README.md").read_text(encoding="utf-8")
|
|
if DYNAMIC_BADGE not in readme:
|
|
errors.append(
|
|
"README.md release badge is not the dynamic pyproject-reading "
|
|
"shields.io badge; a hardcoded version WILL go stale"
|
|
)
|
|
if re.search(r"badge/release-\d+\.\d+\.\d+-", readme):
|
|
errors.append(
|
|
"README.md carries a hardcoded release-X.Y.Z badge; use the "
|
|
"dynamic badge only"
|
|
)
|
|
except OSError as exc:
|
|
errors.append(f"could not read README.md: {exc}")
|
|
|
|
# --- report ------------------------------------------------------------------
|
|
for error in errors:
|
|
print(f"ERROR {error}")
|
|
|
|
if errors:
|
|
print(f"\n{len(errors)} problem(s) found.")
|
|
sys.exit(1)
|
|
|
|
print(f"OK - release preflight passed for version {pyproject_version}.")
|