diff --git a/.gitea/workflows/verify.yml b/.gitea/workflows/verify.yml index 2686bff0..96ce9103 100644 --- a/.gitea/workflows/verify.yml +++ b/.gitea/workflows/verify.yml @@ -48,12 +48,33 @@ jobs: if: steps.surface.outputs.surface != 'documentation' run: python3 ci/test-pr-surface.py + - name: Check workflow-only change + if: steps.surface.outputs.surface == 'workflow' + run: | + python3 - <<'PY' + from pathlib import Path + import yaml + for path in Path('.gitea/workflows').glob('*.yml'): + yaml.load(path.read_text(), Loader=yaml.BaseLoader) + PY + python3 ci/check-runner-image.py + for script in ci/*.sh; do bash -n "$script"; done + base="$(git merge-base HEAD "origin/$GITHUB_BASE_REF")" + git diff --check "$base" HEAD + if git grep -nIE '^[[:space:]]*-----BEGIN (RSA |EC |OPENSSH )?PRIVATE KEY-----[[:space:]]*$' --; then + echo "private key material found in tracked source" >&2 + exit 1 + else + status=$? + [ "$status" -eq 1 ] + fi + - name: Install build dependencies - if: steps.surface.outputs.surface != 'documentation' + if: steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full' run: bash ci/ensure-build-deps.sh base - name: Configure bounded Rust compiler cache - if: steps.surface.outputs.surface != 'documentation' + if: steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full' run: bash ci/configure-rust-cache.sh - name: Compute wxWidgets cache key @@ -138,7 +159,7 @@ jobs: # runner must not fail the gate on it. Accepted advisories live in # .cargo/audit.toml. - name: Dependency audit (best-effort) - if: steps.surface.outputs.surface != 'documentation' + if: steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full' continue-on-error: true run: | if command -v cargo-audit >/dev/null 2>&1; then @@ -147,7 +168,7 @@ jobs: echo "cargo-audit not installed on this runner; skipping" fi - name: Rust compiler cache statistics - if: always() && steps.surface.outputs.surface != 'documentation' + if: always() && (steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full') run: | if [ -n "${SCCACHE_DIR:-}" ]; then sccache --show-stats diff --git a/ci/pr-surface.py b/ci/pr-surface.py index 42c4ed1c..6013a97a 100644 --- a/ci/pr-surface.py +++ b/ci/pr-surface.py @@ -22,6 +22,15 @@ def documentation_only(paths: list[str]) -> bool: ) +def workflow_only(paths: list[str]) -> bool: + """Limit the cheap PR check to workflow YAML, never policy code.""" + return bool(paths) and all( + path.startswith(".gitea/workflows/") and + len(Path(path).parts) == 3 and Path(path).suffix == ".yml" + for path in paths + ) + + def headless_packages(paths: list[str]) -> list[str]: """Return tested reverse dependents for code outside the GUI graph.""" changed: set[str] = set() @@ -95,12 +104,15 @@ def main() -> None: try: paths = changed_paths() docs = documentation_only(paths) - packages = headless_packages(paths) if not docs else [] + workflow = workflow_only(paths) if not docs else False + packages = headless_packages(paths) if not docs and not workflow else [] except (OSError, subprocess.CalledProcessError, ValueError): paths = [] docs = False + workflow = False packages = [] - surface = "documentation" if docs else "headless" if packages else "full" + surface = ("documentation" if docs else "workflow" if workflow else + "headless" if packages else "full") print(f"surface={surface}") print(f"packages={' '.join(packages)}") print(f"Changed paths: {len(paths)}", file=sys.stderr) diff --git a/ci/test-pr-surface.py b/ci/test-pr-surface.py index 324a9f30..047ad11d 100644 --- a/ci/test-pr-surface.py +++ b/ci/test-pr-surface.py @@ -4,13 +4,16 @@ import os from pathlib import Path +import shutil import subprocess import tempfile import importlib.util +import yaml SCRIPT = Path(__file__).with_name("pr-surface.py") +ROOT = SCRIPT.parents[1] spec = importlib.util.spec_from_file_location("pr_surface", SCRIPT) assert spec and spec.loader pr_surface = importlib.util.module_from_spec(spec) @@ -24,8 +27,86 @@ def git(directory: Path, *args: str) -> str: ).strip() +def check_workflow_contract() -> None: + """Keep the short workflow check from silently dropping release gates.""" + required = { + "release.yml": ("main", "release", ( + "Check runner image pins", "Clippy (our crate, warnings are errors)", + "Build release", "Unit tests", "Microbenchmarks", + "Headless UI self-test", "Coverage", "Microbenchmark coverage", + "Generate measured badges", "Publish measured badges", + "Record private benchmark history", "Create Gitea release + upload artifact", + "Clean generated Toolkit build", + )), + "next.yml": ("next", "candidate", ( + "Check runner image pins", "Build release candidate", + "Create private prerelease", "Clean generated Toolkit build", + )), + "verify.yml": ("main", "verify", ( + "Check runner image pins", "Detect changed surface", + "Check CI change surface", "Check workflow-only change", + "Clippy (our crate, warnings are errors)", "Build", "Unit tests", + "Microbenchmarks", "Headless UI self-test", "Clean generated Toolkit build", + )), + } + for filename, (branch, job_name, gates) in required.items(): + path = ROOT / ".gitea/workflows" / filename + workflow = yaml.load(path.read_text(), Loader=yaml.BaseLoader) + event = "pull_request" if filename == "verify.yml" else "push" + assert workflow["on"][event]["branches"] == [branch], path + job = workflow["jobs"][job_name] + assert job["runs-on"] in {"alkane-ci", "alkane-verify"}, path + steps = job["steps"] + names = [step.get("name") for step in steps] + positions = [names.index(gate) for gate in gates] + assert positions == sorted(positions), path + assert steps[positions[-1]].get("if") == "always()", path + for gate, position in zip(gates[:-1], positions[:-1]): + condition = steps[position].get("if") + if gate in {"Create Gitea release + upload artifact", + "Create private prerelease"}: + assert condition is not None and "release == 'true'" in condition, path + elif filename == "verify.yml" and gate in { + "Build", "Unit tests", "Microbenchmarks", + "Clippy (our crate, warnings are errors)", + "Headless UI self-test"}: + assert condition == "steps.surface.outputs.surface == 'full'", path + elif filename == "verify.yml" and gate == "Check CI change surface": + assert condition == "steps.surface.outputs.surface != 'documentation'", path + elif filename == "verify.yml" and gate == "Check workflow-only change": + assert condition == "steps.surface.outputs.surface == 'workflow'", path + else: + assert condition is None, path + + def main() -> None: + check_workflow_contract() + with tempfile.TemporaryDirectory(prefix="alkane-toolkit-workflow-policy-") as directory: + global ROOT + saved_root = ROOT + ROOT = Path(directory) + (ROOT / ".gitea/workflows").mkdir(parents=True) + for filename in ("release.yml", "next.yml", "verify.yml"): + shutil.copyfile(saved_root / ".gitea/workflows" / filename, + ROOT / ".gitea/workflows" / filename) + release = ROOT / ".gitea/workflows/release.yml" + original = release.read_text() + release.write_text(original.replace("- name: Coverage", "- name: Skipped coverage", 1)) + try: + check_workflow_contract() + except ValueError: + pass + else: + raise AssertionError("removing the coverage gate passed workflow policy") + ROOT = saved_root assert pr_surface.documentation_only(["README.md", "docs/setup.md"]) + assert pr_surface.workflow_only([".gitea/workflows/release.yml"]) + for paths in ([], ["ci/pr-surface.py"], ["ci/coverage.sh"], + ["ci/check-runner-image.py"], + [".gitea/workflows/release.yml", "ci/check-runner-image.py"], + [".gitea/workflows/release.yml", "crates/alkane-gui/src/main.rs"], + [".gitea/workflows/../release.yml"]): + assert not pr_surface.workflow_only(paths), paths for paths in ([], ["docs/generated.json"], ["src/main.rs"], ["README.md", "ci/pr-surface.py"]): assert not pr_surface.documentation_only(paths), paths @@ -105,7 +186,7 @@ def main() -> None: pr_surface.ROOT = saved_root os.environ.clear() os.environ.update(saved_env) - print("Toolkit PR change surface: documentation, headless, and fallback PASS") + print("Toolkit PR change surface: documentation, workflow, headless, and fallback PASS") if __name__ == "__main__":