mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 15:07:29 +08:00
## Description Every third-party action in `.github/` ran from a version tag like `actions/checkout@v7`. A tag can be moved to other code at any time. That is how `tj-actions/changed-files` leaked CI secrets from ~23,000 repos in March 2025. Here a moved tag would run with the release job's PyPI OIDC token (`id-token: write`) and the Docker job's `packages: write` token. Pinning to a commit SHA closes that, and a new test keeps it closed. Closes # ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [x] Code refactoring (no functional changes) ## Changes Made - All 195 third-party `uses:` refs in 25 files now name the commit their tag points to today, with the version as a comment: `actions/checkout@3d3c42e5... # v7.0.1`. No action version changes. - Dependabot's existing `github-actions` config updates SHA pins and their version comments, so the pins stay current. - Pin dtolnay/rust-toolchain stable and 1.95.0 branches to their existing commit heads. The stable action retains its runtime toolchain input/default; the 1.95.0 action embeds toolchain: 1.95.0. This preserves each call site's existing toolchain selection. - New `test_every_action_is_pinned_to_a_commit_sha` in `scripts/tests/test_ci_workflow.py` fails on any tag-pinned action and lists each one. - Three tests in `tests/test_release_workflows.py` matched the old tag text (`setup-buildx-action@v4`, `gh-action-pypi-publish@vX.Y.Z`, `release-please-action@v4/v5`). They now match the SHA pin and its version comment. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [ ] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text $ uv run --frozen --extra dev pytest -q scripts/tests/test_ci_workflow.py scripts/tests/test_pr_health_workflow.py scripts/tests/test_normalize_release_pr_bodies.py tests/test_release_workflows.py 87 passed in 0.87s $ uv run --frozen --extra dev pytest -q scripts/tests/test_pr_health_labels.py scripts/tests/test_version_sync.py tests/test_cli/test_wrap_copilot.py tests/test_learn/test_subagent_scanning.py tests/test_plugin_manifests.py tests/test_pr208_changes.py 114 passed in 1.32s $ uvx ruff check scripts/tests/test_ci_workflow.py tests/test_release_workflows.py && uvx ruff format --check <same> All checks passed! ``` ## Real Behavior Proof - Environment: macOS, Python 3.12 via `uv run --frozen --extra dev`, branch cut from `main` atc01cf07d. - Exact command / steps: resolved each tag with `git ls-remote --tags --heads https://github.com/<owner>/<repo>` (peeled for annotated tags), rewrote only the `uses:` lines, then ran the test files above and a `yaml.safe_load` over every file in `.github/`. - Observed result: 195 lines changed, 195 removed, no other line touched (mixed LF/CRLF in `pr-health.yml` kept). All 201 tests pass. On `main` the new test fails and lists the unpinned refs. - Not tested: `scripts/validate-workflows.sh` (actionlint plus act dry runs) was not run locally. The `workflow-validation` job runs it on this PR. ## Runtime Rollout Safety - Rollout-managed feature(s): None. CI workflow files and their tests only. - Minimum rollout channel: N/A, no runtime code changes. - Stable/default behavior changed: No. Each SHA is the commit its tag points to today. - Kill switch / disable path: N/A, revert the commit. - Unsafe override required: No. - Qualification impact: None. - Rollback path: Revert this PR. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] I did **not** edit `CHANGELOG.md` — it is generated by release-please from my Conventional Commit PR title (a CI guard enforces this) ## Screenshots (if applicable) N/A, no UI change. ## Additional Notes - mypy and docs are N/A: no `headroom/` code or documented behavior changes. - Dependabot does not bump branch pins, so the two `dtolnay/rust-toolchain` pins stay on today's branch head until someone moves them. That action rarely changes. 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/headroomlabs-ai/headroom/pull/4671" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-devin-review-dark.svg?v=4"><img src="https://static.devin.ai/assets/gh-devin-review-light.svg?v=4" alt="Devin Review"></picture></a> <!-- devin-review-badge-end --> ### Maintainer current-main requalification Exact head `57b7edd8d05b6dc5e3bc4eac1dff55f21519afe8`, upstream main `c01cf07d943d816cfd9d97e6838ed4e38f1ff9a4`. Reviewed the27-file delta and existing discussion/Devin no-issues result against current upstream mainc01cf07d94, already included in the contributor head. Independent full-workflow comparison proves only uses refs/comments change across the25 workflow/action files. All195 replaced refs resolve exactly to their original upstream tag/branch commits (29 unique pins across26 repositories), with annotated tags peeled; no mismatches. Pinned dtolnay action source independently confirms stable runtime default versus embedded1.95.0 branch behavior, preserving toolchain selection.87 workflow/release tests and113 adjacent tests pass,1skip; changed Python lint/format passes. Maintainer fix only removes CRLF endings on two edited pr-health lines to clear whitespace; provenance reverified afterward. No contributor workflow logic altered. Description is corrected to explain embedded1.95.0 semantics. No publish/release workflow execution claimed; full hosted qualification must run on this new mechanical-fix head. Maintainers handle CI. Nothing merged. Exact-head hosted checks are being handled by maintainers. No new finding in the reviewed scope; formal approval awaits exact-head hosted qualification; nothing merged. --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
262 lines
11 KiB
YAML
262 lines
11 KiB
YAML
name: rust
|
|
|
|
# Path gating lives in the `rust-changes` job below, NOT in a workflow-level
|
|
# `paths:` filter. The distinction matters for branch protection: a workflow
|
|
# skipped by `paths:` never creates its check runs at all, so a required status
|
|
# check from it sits pending forever on any PR that misses those paths, and the
|
|
# PR can never merge. A job skipped by `if:` still creates a check run, reports
|
|
# `skipped`, and GitHub counts skipped as success for a required check.
|
|
#
|
|
# Same coverage as the old filter — the path list moved verbatim into
|
|
# `rust-changes` — but `parity` is now safe to mark required on `main`.
|
|
on:
|
|
push:
|
|
branches: [ main, rust-rewrite ]
|
|
pull_request:
|
|
schedule:
|
|
# Nightly parity run at 07:17 UTC (weekdays only). Redundant with the
|
|
# per-PR gate below, but catches drift from toolchain/dependency updates
|
|
# that land without touching any filtered path.
|
|
- cron: '17 7 * * 1-5'
|
|
|
|
concurrency:
|
|
group: rust-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
# Default permissions: read-only. Individual jobs override only what they need.
|
|
# Mitigates CodeQL/CWE-275 (missing-workflow-permissions): the GITHUB_TOKEN
|
|
# defaults to whatever the repo policy is, which can be read-write. Pinning
|
|
# this here means even if the repo default changes, this workflow stays safe.
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
# Carries the path list the workflow-level `paths:` filter used to hold. Named
|
|
# `rust-changes` rather than `changes` so it does not collide with ci.yml's
|
|
# `changes` check.
|
|
rust-changes:
|
|
name: rust-changes
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 5
|
|
outputs:
|
|
rust: ${{ steps.decide.outputs.rust }}
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- uses: dorny/paths-filter@ceb8a2b8f2d89434be7ff52d3de7ec3738c5cc9d # v4.0.3
|
|
id: filter
|
|
if: github.event_name == 'pull_request' || github.event_name == 'push'
|
|
with:
|
|
filters: |
|
|
rust:
|
|
- 'crates/**'
|
|
- 'Cargo.toml'
|
|
- 'Cargo.lock'
|
|
- 'rust-toolchain.toml'
|
|
- 'tests/parity/**'
|
|
- 'Makefile'
|
|
- '.github/workflows/rust.yml'
|
|
- id: decide
|
|
# `schedule` and `workflow_dispatch` have no diff to filter against, so
|
|
# they run the full suite — that is the point of the nightly job.
|
|
run: |
|
|
case "${{ github.event_name }}" in
|
|
pull_request|push) echo "rust=${{ steps.filter.outputs.rust }}" >> "$GITHUB_OUTPUT" ;;
|
|
*) echo "rust=true" >> "$GITHUB_OUTPUT" ;;
|
|
esac
|
|
|
|
test:
|
|
# `test (ubuntu)` keeps its exact check name, which branch protection may
|
|
# require. macOS runs only `cargo test`: the magika/ORT tests there take a
|
|
# different path (Core ML EP, `ps -M` thread counts, #4191) that Linux
|
|
# never exercises; fmt/clippy stay on Ubuntu.
|
|
name: test (${{ matrix.name }})
|
|
needs: rust-changes
|
|
if: needs.rust-changes.outputs.rust == 'true'
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 30
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- name: ubuntu
|
|
os: ubuntu-latest
|
|
- name: macos
|
|
os: macos-26
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Install stable toolchain
|
|
# Pin action code to @stable (latest fixes), toolchain version
|
|
# via input. The @1.95.0 ref shipped action code that errors on
|
|
# ubuntu-latest with `detected conflict: 'bin/cargo-clippy'`
|
|
# because the pre-installed runner Rust collides with the
|
|
# clippy-preview component install.
|
|
uses: dtolnay/rust-toolchain@b725eda525362e7cf34af9a7243cac1e3f01a7ec # stable
|
|
with:
|
|
toolchain: 1.95.0
|
|
components: rustfmt, clippy
|
|
- name: Cache cargo registry + build
|
|
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
|
|
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
|
with:
|
|
python-version: '3.11'
|
|
- name: Provide ONNX Runtime dylib
|
|
# headroom-core is built with `ort-load-dynamic` (see its
|
|
# Cargo.toml): the ONNX Runtime shared library is dlopen'd at
|
|
# runtime instead of statically linked, so the magika/detection
|
|
# tests need a real libonnxruntime.so and ORT_DYLIB_PATH pointing
|
|
# at it — same contract `headroom/_ort.py` fulfills for Python
|
|
# users via the pip `onnxruntime` package.
|
|
run: |
|
|
# >= 1.24, not 1.16: `ort`'s ORT_API_VERSION resolves to 24 because
|
|
# `fastembed` enables its `api-24` feature.
|
|
pip install 'onnxruntime>=1.24'
|
|
# Pre-flight, not just a pin. `ort` deadlocks rather than errors on
|
|
# ANY failure inside `load_dylib_from_path` — a version mismatch and
|
|
# a library that cannot be resolved at all both re-enter the `Once`
|
|
# that `setup_api()` is initialising, and `std::sync::Once` blocks
|
|
# forever on re-entry. Either way the job burns its full 30-minute
|
|
# timeout at 0% CPU with nothing in the log. Assert both conditions
|
|
# here so a bad runner fails in seconds with a readable message.
|
|
python - <<'PY' >> "$GITHUB_ENV"
|
|
import pathlib, sys
|
|
|
|
def die(msg: str) -> None:
|
|
print(f"::error::{msg}", file=sys.stderr)
|
|
raise SystemExit(1)
|
|
|
|
try:
|
|
import onnxruntime
|
|
except Exception as exc: # noqa: BLE001 - any import failure is fatal here
|
|
die(f"onnxruntime is not importable: {exc}")
|
|
|
|
version = onnxruntime.__version__
|
|
try:
|
|
major, minor = (int(part) for part in version.split(".")[:2])
|
|
except ValueError:
|
|
die(f"cannot parse onnxruntime version {version!r}")
|
|
if (major, minor) < (1, 24):
|
|
die(
|
|
f"onnxruntime {version} is too old: ort requires >= 1.24 "
|
|
"(ORT_API_VERSION=24, set by fastembed's api-24 feature). "
|
|
"ort DEADLOCKS instead of erroring below this, so the tests "
|
|
"would hang rather than fail."
|
|
)
|
|
|
|
capi = pathlib.Path(onnxruntime.__file__).parent / "capi"
|
|
libs = sorted(capi.glob("libonnxruntime.so*")) or sorted(capi.glob("libonnxruntime*.dylib"))
|
|
if not libs:
|
|
die(f"no libonnxruntime shared library under {capi}")
|
|
|
|
print(f"ORT_DYLIB_PATH={libs[0]}")
|
|
print(f"onnxruntime {version} -> {libs[0]}", file=sys.stderr)
|
|
PY
|
|
- name: cargo fmt --check
|
|
if: matrix.os == 'ubuntu-latest'
|
|
run: cargo fmt --all -- --check
|
|
- name: cargo clippy
|
|
if: matrix.os == 'ubuntu-latest'
|
|
run: cargo clippy --workspace -- -D warnings
|
|
- name: cargo test
|
|
run: cargo test --workspace
|
|
- name: cargo test (magika idle threads)
|
|
# Cargo stops at the first failing test binary, so a failure elsewhere
|
|
# in the suite would skip this macOS-specific check (#4191). Run it on
|
|
# its own even then; --nocapture keeps its thread counts in the log.
|
|
if: ${{ !cancelled() && matrix.os == 'macos-26' }}
|
|
run: cargo test -p headroom-core --test magika_idle_threads -- --nocapture
|
|
|
|
simulator-e2e:
|
|
name: simulator e2e (${{ matrix.os }})
|
|
needs: rust-changes
|
|
if: needs.rust-changes.outputs.rust == 'true'
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 30
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Install stable toolchain
|
|
uses: dtolnay/rust-toolchain@b725eda525362e7cf34af9a7243cac1e3f01a7ec # stable
|
|
with:
|
|
toolchain: 1.95.0
|
|
- name: Cache cargo registry + build
|
|
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
|
|
- name: cargo test simulator-backed proxy e2e
|
|
run: cargo test -p headroom-proxy --test e2e_simulators
|
|
|
|
wheels:
|
|
name: wheels (${{ matrix.target }})
|
|
needs: rust-changes
|
|
if: needs.rust-changes.outputs.rust == 'true'
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 45
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- os: ubuntu-latest
|
|
target: x86_64-unknown-linux-gnu
|
|
maturin-target: x86_64
|
|
- os: macos-26
|
|
target: aarch64-apple-darwin
|
|
maturin-target: aarch64-apple-darwin
|
|
- os: macos-15-intel
|
|
target: x86_64-apple-darwin
|
|
maturin-target: x86_64-apple-darwin
|
|
# Intel macOS uses `ort-load-dynamic` (no prebuilt ORT from ort-sys);
|
|
# Apple Silicon bundles ORT via `ort-download-binaries-rustls-tls`.
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
|
with:
|
|
python-version: '3.11'
|
|
- name: "Build wheel (single-wheel architecture builds headroom-ai)"
|
|
uses: PyO3/maturin-action@e83996d129638aa358a18fbd1dfb82f0b0fb5d3b # v1.51.0
|
|
# Maturin reads `[tool.maturin]` from the root `pyproject.toml`
|
|
# which points at `crates/headroom-py/Cargo.toml` for the cdylib.
|
|
# Output is `headroom_ai-<ver>-<py>-<py>-<platform>.whl` containing
|
|
# both Python source and the compiled `headroom/_core.so`.
|
|
with:
|
|
command: build
|
|
args: --release --out dist
|
|
target: ${{ matrix.maturin-target }}
|
|
- name: Upload wheel artifact
|
|
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
with:
|
|
name: wheels-${{ matrix.target }}
|
|
path: dist/*.whl
|
|
|
|
# The Rust dependency advisory scan (`cargo audit`) moved to security.yml,
|
|
# where it runs on every PR and push regardless of which paths changed. Here
|
|
# it sat behind the `rust-changes` filter and this workflow's schedule, and
|
|
# that combination let three weeks pass with no scan at all.
|
|
|
|
# Blocking on every PR that touches Rust. Safe to harden now because the
|
|
# harness fails only on a Diff — `parity-run` sets `any_diffs` inside the
|
|
# diffed loop alone, so the 65 fixtures still served by `stub_comparator!`
|
|
# report as Skipped and cannot turn this red. Measured on main today:
|
|
# 111 matched / 65 skipped / 0 diffed.
|
|
#
|
|
# What it protects: the recorded fixtures are frozen Python output, so this
|
|
# gate catches the Rust side drifting away from that snapshot — exactly the
|
|
# failure mode the ongoing port produces. It cannot detect the Python side
|
|
# drifting away from the fixtures; that needs re-recording, not this job.
|
|
parity:
|
|
name: parity
|
|
needs: rust-changes
|
|
if: needs.rust-changes.outputs.rust == 'true'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- uses: dtolnay/rust-toolchain@b725eda525362e7cf34af9a7243cac1e3f01a7ec # stable
|
|
with:
|
|
toolchain: 1.95.0
|
|
- uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
|
|
# No Python toolchain: headroom-parity links headroom-core directly and
|
|
# never crosses into the interpreter, so the venv + maturin + `pip
|
|
# install -e .` setup this job used to do was pure overhead.
|
|
- name: Run parity harness
|
|
run: make test-parity
|