kingchenc
62ab84c472
Introduce repo-metadata.toml as single source of truth for repo identity (org slug, maintainer email, canonical URLs) and add sync-metadata.yml workflow with a Python audit script that fails CI if any tracked file drifts back to pre-migration values. Bulk-replace across 24 tracked files: - kingchenc/wickra -> wickra-lib/wickra (URL segment) - kingchencp@gmail.com -> wickra.lib@gmail.com (maintainer email) - @kingchenc -> @wickra-lib (CODEOWNERS mention only) Person-name credits are preserved: LICENSE copyright holder, Cargo.toml authors handle, and CHANGELOG historical @kingchenc reference all remain unchanged. Crate / PyPI / npm package names also untouched. Merge this PR only after the kingchenc/wickra -> wickra-lib/wickra org transfer has happened on the GitHub side, otherwise all badges and repository links 404 until the transfer is performed.
114 lines
3.6 KiB
Python
114 lines
3.6 KiB
Python
"""Audit that no file in the repo contains the pre-migration org slug or
|
|
maintainer email. Driven by `repo-metadata.toml` at the repo root.
|
|
|
|
This is the read-only side of the metadata pipeline. It does not patch any
|
|
files — it just fails CI when drift sneaks in. Pair with a future
|
|
`--write` mode (auto-fix + signed commit on main) once the migration has
|
|
settled.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
import tomllib
|
|
from pathlib import Path
|
|
|
|
REPO_ROOT = Path(__file__).resolve().parents[2]
|
|
METADATA_PATH = REPO_ROOT / "repo-metadata.toml"
|
|
|
|
|
|
def load_metadata() -> dict:
|
|
with METADATA_PATH.open("rb") as f:
|
|
return tomllib.load(f)
|
|
|
|
|
|
def is_allowlisted(rel_path: str, allowlist: list[str]) -> bool:
|
|
norm = rel_path.replace(os.sep, "/")
|
|
for entry in allowlist:
|
|
entry_norm = entry.replace(os.sep, "/")
|
|
if entry_norm.endswith("/"):
|
|
if norm.startswith(entry_norm):
|
|
return True
|
|
else:
|
|
if norm == entry_norm:
|
|
return True
|
|
return False
|
|
|
|
|
|
def tracked_files() -> list[str]:
|
|
"""List git-tracked files relative to the repo root."""
|
|
out = subprocess.run(
|
|
["git", "ls-files"],
|
|
cwd=REPO_ROOT,
|
|
check=True,
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
return [line for line in out.stdout.splitlines() if line]
|
|
|
|
|
|
def scan(forbidden: list[str], allowlist: list[str]) -> list[tuple[str, int, str, str]]:
|
|
"""Return a list of (rel_path, line_no, needle, line_text) findings.
|
|
|
|
Only git-tracked files are scanned, so local-only ghost-ignored files
|
|
(`.claude/`, drafts) never trigger false positives.
|
|
"""
|
|
findings: list[tuple[str, int, str, str]] = []
|
|
for rel_path in tracked_files():
|
|
if is_allowlisted(rel_path, allowlist):
|
|
continue
|
|
abs_path = REPO_ROOT / rel_path
|
|
if not abs_path.is_file():
|
|
continue
|
|
try:
|
|
lines = abs_path.read_text(encoding="utf-8", errors="replace").splitlines()
|
|
except (OSError, UnicodeDecodeError):
|
|
continue
|
|
for lineno, line in enumerate(lines, start=1):
|
|
for needle in forbidden:
|
|
if needle in line:
|
|
findings.append((rel_path, lineno, needle, line.strip()))
|
|
return findings
|
|
|
|
|
|
def main() -> int:
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument("--check", action="store_true", help="audit-only (default)")
|
|
args = parser.parse_args()
|
|
_ = args # currently only --check is supported
|
|
|
|
meta = load_metadata()
|
|
audit = meta.get("audit", {})
|
|
forbidden: list[str] = list(audit.get("forbidden", []))
|
|
allowlist: list[str] = list(audit.get("allowlist", []))
|
|
|
|
if not forbidden:
|
|
print("repo-metadata.toml [audit].forbidden is empty — nothing to scan.")
|
|
return 0
|
|
|
|
findings = scan(forbidden, allowlist)
|
|
if findings:
|
|
print(f"sync-metadata: {len(findings)} forbidden-substring hits:", file=sys.stderr)
|
|
for rel_path, lineno, needle, text in findings:
|
|
print(f" {rel_path}:{lineno}: matched {needle!r}", file=sys.stderr)
|
|
print(f" {text}", file=sys.stderr)
|
|
print(
|
|
"\nUpdate the offending lines to use the values from repo-metadata.toml,",
|
|
"or add the path to [audit].allowlist if the reference is intentional",
|
|
"(e.g. historical CHANGELOG entries).",
|
|
file=sys.stderr,
|
|
)
|
|
return 1
|
|
|
|
org = meta["repo"]["org"]
|
|
email = meta["maintainer"]["email"]
|
|
print(f"sync-metadata: clean. org={org!r} email={email!r}")
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|