mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 15:10:00 +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>
144 lines
5.4 KiB
YAML
144 lines
5.4 KiB
YAML
name: Init Native E2E
|
|
|
|
# Cross-platform (linux / macos / windows) smoke tests for the per-subcommand
|
|
# ``headroom init -g <target>`` flows. Each matrix cell drops a noop shim for
|
|
# the target agent onto PATH and asserts ``headroom init -g <target>``
|
|
# succeeds, writes the expected settings file, and (for claude/codex) places
|
|
# hooks in the right place.
|
|
#
|
|
# Deliberately scoped to pull_request + push-to-main + workflow_dispatch to
|
|
# avoid bloating CI minutes on every push to every feature branch. The Docker
|
|
# init-e2e.yml still runs on every PR and provides the deeper functional
|
|
# coverage; this workflow exists to catch platform-specific bugs (Windows
|
|
# path separators, macos keychain prompts, PowerShell-vs-bash hook matchers)
|
|
# that the single-platform Docker suite can miss.
|
|
#
|
|
# Extending to other commands (``headroom install``, ``headroom wrap``) is
|
|
# expected to be a near-copy of this file. The shared composite action at
|
|
# ``.github/actions/headroom-e2e-setup`` absorbs the Python + shim setup so
|
|
# each per-command workflow only supplies its matrix and assertion steps.
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [main]
|
|
paths:
|
|
- "headroom/cli/init.py"
|
|
- "headroom/install/**"
|
|
- "e2e/_lib/**"
|
|
- "e2e/init/**"
|
|
- ".github/actions/headroom-e2e-setup/**"
|
|
- ".github/workflows/init-native-e2e.yml"
|
|
push:
|
|
branches: [main]
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
init-native:
|
|
runs-on: ${{ matrix.os }}
|
|
timeout-minutes: 25
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
# Windows is excluded today: upstream `esaxx-rs` (transitively from
|
|
# `tokenizers`) and `ort-sys` (onnxruntime via `fastembed`) link
|
|
# with conflicting MSVC C runtime libraries (/MT vs /MD), so the
|
|
# Rust extension cannot build for `win_amd64` until the upstream
|
|
# CRT conflict is resolved. Re-add `windows-latest` once the wheel
|
|
# builds cleanly there. Tracked in the project plan; not a blocker
|
|
# for headroom-ai installs on Linux + macOS.
|
|
os: [ubuntu-latest, macos-latest]
|
|
target: [claude, codex, copilot, openclaw]
|
|
exclude:
|
|
# openclaw delegates to ``headroom wrap openclaw`` which needs a
|
|
# running OpenClaw CLI; it can't be shimmed cheaply, so it's
|
|
# covered by the bundled Docker e2e instead.
|
|
- target: openclaw
|
|
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
|
|
- name: Setup (shim=${{ matrix.target }})
|
|
uses: ./.github/actions/headroom-e2e-setup
|
|
with:
|
|
install-mode: deps-only-proxy
|
|
python-version: "3.11"
|
|
shim-target: ${{ matrix.target }}
|
|
|
|
- name: Verify shim is on PATH (POSIX)
|
|
if: runner.os != 'Windows'
|
|
shell: bash
|
|
run: |
|
|
which "${{ matrix.target }}"
|
|
|
|
- name: Verify shim is on PATH (Windows)
|
|
if: runner.os == 'Windows'
|
|
shell: pwsh
|
|
run: |
|
|
# On Windows the shim is ``<target>.cmd``; Get-Command resolves via
|
|
# PATHEXT (same as Python's ``shutil.which`` used by headroom init).
|
|
# Git Bash's ``which`` cannot find ``.cmd`` shims, so we use pwsh.
|
|
$cmd = Get-Command "${{ matrix.target }}" -ErrorAction Stop
|
|
Write-Output $cmd.Source
|
|
|
|
- name: Run headroom init -g ${{ matrix.target }}
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
headroom init -g "${{ matrix.target }}"
|
|
|
|
- name: Assert settings file (POSIX)
|
|
if: runner.os != 'Windows'
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
case "${{ matrix.target }}" in
|
|
claude)
|
|
test -f "$HOME/.claude/settings.json"
|
|
grep -q "ANTHROPIC_BASE_URL" "$HOME/.claude/settings.json"
|
|
;;
|
|
codex)
|
|
test -f "$HOME/.codex/config.toml"
|
|
test -f "$HOME/.codex/hooks.json"
|
|
grep -q "headroom" "$HOME/.codex/config.toml"
|
|
;;
|
|
copilot)
|
|
test -f "$HOME/.copilot/config.json"
|
|
grep -q "SessionStart" "$HOME/.copilot/config.json"
|
|
;;
|
|
esac
|
|
|
|
- name: Assert settings file (Windows)
|
|
if: runner.os == 'Windows'
|
|
shell: pwsh
|
|
run: |
|
|
$ErrorActionPreference = "Stop"
|
|
$home_ = $env:USERPROFILE
|
|
switch ("${{ matrix.target }}") {
|
|
"claude" {
|
|
$p = Join-Path $home_ ".claude\settings.json"
|
|
if (-not (Test-Path $p)) { throw "Missing $p" }
|
|
if (-not ((Get-Content $p -Raw) -match "ANTHROPIC_BASE_URL")) {
|
|
throw "settings.json missing ANTHROPIC_BASE_URL"
|
|
}
|
|
}
|
|
"codex" {
|
|
$c = Join-Path $home_ ".codex\config.toml"
|
|
$h = Join-Path $home_ ".codex\hooks.json"
|
|
if (-not (Test-Path $c)) { throw "Missing $c" }
|
|
if (-not (Test-Path $h)) { throw "Missing $h" }
|
|
if (-not ((Get-Content $c -Raw) -match "headroom")) {
|
|
throw "config.toml missing headroom provider"
|
|
}
|
|
}
|
|
"copilot" {
|
|
$p = Join-Path $home_ ".copilot\config.json"
|
|
if (-not (Test-Path $p)) { throw "Missing $p" }
|
|
if (-not ((Get-Content $p -Raw) -match "SessionStart")) {
|
|
throw "copilot config missing SessionStart hooks"
|
|
}
|
|
}
|
|
}
|