mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-09 20:26:33 +00:00
kevinveenbirkenbachandClaude Opus 4.7
d3afe0bc81
Hard-coded self-path references rot the moment the file moves: a header
comment ``# utils/foo/bar.py`` at the top of a module, a docstring
mentioning ``utils/foo/bar.py``, or a docs entry linking
``utils/foo/bar.py`` from inside ``utils/foo/bar.py`` itself all silently
desync from reality after the next ``git mv``.
The new lint walks every project file, computes its POSIX-style relative
path from PROJECT_ROOT, and reports any line whose text contains that
path as a substring. Files at the repo root (no ``/`` in their relative
path) and setuptools-generated ``*.egg-info/`` artefacts are exempt.
Per-line opt-out via ``# nocheck: self-path-reference`` on the offending
line, registered in the suppression catalog.
Existing offenders cleaned up:
- 72 redundant ``# <self-path>`` header lines removed across roles,
cli, plugins, scripts, tests, and utils.
- 4 prometheus templates that told consumers to "update
<self-template-path>" rewritten to drop the redundant self-reference.
- 8 docstring/comment self-references in cli, plugins, tests, utils,
and the dashboard oidc.js.j2 header rewritten to describe the layout
without naming the file's own path.
- 17 legitimate usage examples (shell scripts, test data lists, one
template self-include doc-block) marked with ``nocheck:
self-path-reference``.
- ``container.sh`` heredoc usage strings switched to ``${0}`` so the
marker stays out of the user-visible help output.
- ``healthcheck/http.yml.j2`` doc-block rewritten to prose because
``{# ... #}`` Jinja comments cannot host an inner ``{# nocheck #}``
(the inner ``#}`` closes the outer comment).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
91 lines
2.6 KiB
Python
91 lines
2.6 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
import shlex
|
|
from pathlib import Path
|
|
|
|
CONTAINER_REPO_ROOT = Path("/opt/src/infinito")
|
|
|
|
|
|
def _require_env(name: str) -> str:
|
|
val = os.environ.get(name)
|
|
if val is None or not str(val).strip():
|
|
raise RuntimeError(f"Required environment variable is missing or empty: {name}")
|
|
return str(val).strip()
|
|
|
|
|
|
def _require_bool_env(name: str) -> bool:
|
|
raw = _require_env(name)
|
|
if raw == "true":
|
|
return True
|
|
if raw == "false":
|
|
return False
|
|
raise RuntimeError(
|
|
f"Environment variable {name} must be 'true' or 'false', got {raw!r}"
|
|
)
|
|
|
|
|
|
def should_use_mirrors_on_ci() -> bool:
|
|
"""
|
|
Mirrors are enabled strictly based on RUNNING_ON_GITHUB.
|
|
"""
|
|
return _require_bool_env("RUNNING_ON_GITHUB")
|
|
|
|
|
|
def _exec_env() -> dict[str, str]:
|
|
"""
|
|
All variables are mandatory. No fallbacks.
|
|
"""
|
|
return {
|
|
"RUNNING_ON_GITHUB": _require_env("RUNNING_ON_GITHUB"),
|
|
"GITHUB_REPOSITORY_OWNER": _require_env("GITHUB_REPOSITORY_OWNER"),
|
|
"GITHUB_REPOSITORY": _require_env("GITHUB_REPOSITORY"),
|
|
"INFINITO_GHCR_MIRROR_PREFIX": _require_env("INFINITO_GHCR_MIRROR_PREFIX"),
|
|
}
|
|
|
|
|
|
def generate_ci_mirrors_file(compose, *, inventory_dir: str) -> str:
|
|
"""
|
|
Generate mirrors.yml inside the container using cli.mirror.resolver.
|
|
|
|
Writes:
|
|
<inventory_dir>/mirrors.yml
|
|
"""
|
|
inv_root = str(inventory_dir).rstrip("/")
|
|
if not inv_root:
|
|
raise RuntimeError("inventory_dir must not be empty")
|
|
|
|
env = _exec_env()
|
|
ghcr_namespace = env["GITHUB_REPOSITORY_OWNER"].lower()
|
|
ghcr_repository = env["GITHUB_REPOSITORY"].split("/", 1)[-1].lower()
|
|
ghcr_prefix = env["INFINITO_GHCR_MIRROR_PREFIX"].strip().strip("/")
|
|
if not ghcr_prefix:
|
|
raise RuntimeError("INFINITO_GHCR_MIRROR_PREFIX must not be empty")
|
|
|
|
mirrors_path = f"{inv_root}/mirrors.yml"
|
|
repo_root = str(CONTAINER_REPO_ROOT)
|
|
|
|
cmd = [
|
|
"bash",
|
|
"-lc",
|
|
"set -euo pipefail; "
|
|
f"mkdir -p {shlex.quote(inv_root)}; "
|
|
'"${PYTHON:-python3}" -m cli.mirror.resolver '
|
|
f"--repo-root {shlex.quote(repo_root)} "
|
|
f"--ghcr-namespace {shlex.quote(ghcr_namespace)} "
|
|
f"--ghcr-repository {shlex.quote(ghcr_repository)} "
|
|
f"--ghcr-prefix {shlex.quote(ghcr_prefix)} "
|
|
f"> {shlex.quote(mirrors_path)}; "
|
|
f"echo '[init] mirrors generated:' {shlex.quote(mirrors_path)}; "
|
|
f"wc -l {shlex.quote(mirrors_path)}",
|
|
]
|
|
|
|
compose.exec(
|
|
cmd,
|
|
check=True,
|
|
workdir=repo_root,
|
|
extra_env=env,
|
|
)
|
|
|
|
return mirrors_path
|