From 09b4275bc72ce16a6c3974ae66295da87ecb4c36 Mon Sep 17 00:00:00 2001 From: Dax Date: Mon, 26 Oct 2026 23:00:48 -0400 Subject: [PATCH] ci: publish nix hashes through an auto-merged pull request (#59464) --- .github/nix-hashes/publish.sh | 66 +++++++++++++ .github/nix-hashes/validate.sh | 27 ++++++ .github/workflows/bot-nix-hashes.yml | 127 +++++++++++++++++--------- .github/workflows/check-bot-scope.yml | 63 +++++++++++++ 4 files changed, 240 insertions(+), 43 deletions(-) create mode 100644 .github/nix-hashes/publish.sh create mode 100644 .github/nix-hashes/validate.sh create mode 100644 .github/workflows/check-bot-scope.yml diff --git a/.github/nix-hashes/publish.sh b/.github/nix-hashes/publish.sh new file mode 100644 index 00000000000..2a3d38f6378 --- /dev/null +++ b/.github/nix-hashes/publish.sh @@ -0,0 +1,66 @@ +#!/usr/bin/env bash +# publish.sh : run from a checkout of dev. Puts on bot/nix-hashes as one commit on top of dev, +# opens or updates the pull request into dev, dispatches its required checks and enables auto-merge. Closes the pull +# request instead when dev already has these hashes. Uses git, gh and jq only; never runs repository code. +set -euo pipefail + +here=$(cd "$(dirname "$0")" && pwd) +new=$(realpath "$1") +branch=bot/nix-hashes +file=nix/hashes.json +title="chore: update nix node_modules hashes" +: "${GH_REPO:?}" "${GITHUB_SHA:?}" +git=(git -c core.hooksPath=/dev/null -c user.name='github-actions[bot]' -c user.email='41898282+github-actions[bot]@users.noreply.github.com') + +bash "$here/validate.sh" "$new" + +"${git[@]}" fetch --no-tags --depth=1 origin "+refs/heads/dev:refs/remotes/origin/dev" "$GITHUB_SHA" + +# A newer push that changed the inputs has its own run, which publishes hashes for it. Mirrors on.push.paths. +if ! git diff --quiet "$GITHUB_SHA" origin/dev -- bun.lock package.json ':(glob)packages/*/package.json' \ + ':(glob)services/*/package.json' flake.lock nix/node_modules.nix nix/scripts patches; then + echo "::notice::dev changed the hash inputs since $GITHUB_SHA; leaving it to the newer run" + exit 0 +fi + +# Only a same-repository pull request is the bot's; a fork can use the same branch name. +find_pr() { + gh pr list --repo "$GH_REPO" --base dev --head "$branch" --state open --json number,isCrossRepository \ + --jq 'map(select(.isCrossRepository | not)) | .[0].number // empty' +} +pr=$(find_pr) + +"${git[@]}" checkout -B "$branch" origin/dev +if cmp -s "$new" "$file"; then + echo "dev already has these hashes" + if [ -n "$pr" ]; then + gh pr close "$pr" --repo "$GH_REPO" --delete-branch --comment "dev already has these hashes." + fi + exit 0 +fi + +cp "$new" "$file" +bash "$here/validate.sh" "$file" +"${git[@]}" add -- "$file" +"${git[@]}" commit --no-verify -m "$title" +[ "$(git diff --name-only origin/dev HEAD)" = "$file" ] || { + echo "::error::the commit changes more than $file" >&2 + exit 1 +} +"${git[@]}" push --no-verify --force origin "HEAD:refs/heads/$branch" + +if [ -z "$pr" ]; then + gh pr create --repo "$GH_REPO" --base dev --head "$branch" --title "$title" \ + --body "Updates \`$file\` to the node_modules hashes computed for $GITHUB_SHA by bot-nix-hashes. check-bot-scope keeps this branch to that file." + pr=$(find_pr) +fi + +# Pushes and pull requests made with GITHUB_TOKEN start no workflows; dispatches do. These produce the checks dev +# requires on the new head. +for workflow in check.yml check-test.yml check-bot-scope.yml; do + gh workflow run "$workflow" --repo "$GH_REPO" --ref "$branch" +done + +gh pr merge "$pr" --repo "$GH_REPO" --auto --squash +echo "### Nix hashes" >> "${GITHUB_STEP_SUMMARY:-/dev/null}" +echo "Updated pull request #$pr" >> "${GITHUB_STEP_SUMMARY:-/dev/null}" diff --git a/.github/nix-hashes/validate.sh b/.github/nix-hashes/validate.sh new file mode 100644 index 00000000000..59a7abf1dd0 --- /dev/null +++ b/.github/nix-hashes/validate.sh @@ -0,0 +1,27 @@ +#!/usr/bin/env bash +# validate.sh : fails unless has exactly the shape of nix/hashes.json, so the hashes bot can only ever publish +# three SRI hashes. Used by bot-nix-hashes.yml before it commits and by check-bot-scope.yml on the bot's pull request. +# Adding a system to the flake means adding it to SYSTEMS here. +set -euo pipefail + +file=${1:?usage: validate.sh } +SYSTEMS='["aarch64-darwin","aarch64-linux","x86_64-linux"]' + +fail() { + echo "::error::$file: $*" >&2 + exit 1 +} + +if [ ! -f "$file" ] || [ -L "$file" ]; then fail "not a regular file"; fi +[ "$(wc -c < "$file")" -lt 4096 ] || fail "4096 bytes or larger" +jq -se 'length == 1' "$file" > /dev/null 2>&1 || fail "not a single JSON value" +jq -e --argjson systems "$SYSTEMS" ' + type == "object" + and keys == ["nodeModules"] + and (.nodeModules | type == "object") + and (.nodeModules | keys == $systems) + and (.nodeModules | all(.[]; type == "string" and test("\\Asha256-[A-Za-z0-9+/]{43}=\\z"))) +' "$file" > /dev/null || fail "expected {\"nodeModules\": {<$SYSTEMS>: \"sha256-<44 base64 chars>\"}}" +# The canonical form rules out duplicate keys and anything else jq would drop on parse. +jq . "$file" | cmp -s - "$file" || fail "not formatted as jq . prints it" +echo "$file: valid" diff --git a/.github/workflows/bot-nix-hashes.yml b/.github/workflows/bot-nix-hashes.yml index 24af010e506..31ddc6b3a2d 100644 --- a/.github/workflows/bot-nix-hashes.yml +++ b/.github/workflows/bot-nix-hashes.yml @@ -1,5 +1,14 @@ name: bot-nix-hashes +# Keeps nix/hashes.json in step with the lockfile through a pull request, using only GITHUB_TOKEN. +# - hash and compute run repository code (nix build) with a read-only token and no secrets. compute uploads only the +# new nix/hashes.json. +# - publish holds the write token. It runs only .github/nix-hashes/ from this commit, treats the artifact as data, +# validates its exact shape and commits only that file to bot/nix-hashes. It never runs repository code. +# - check-bot-scope.yml, a required check, fails the bot's pull request unless it changes only a valid nix/hashes.json, +# so a tampered branch cannot auto-merge. +# This file, check-bot-scope.yml and .github/nix-hashes/ are the security boundary. + permissions: contents: read @@ -7,6 +16,7 @@ on: workflow_dispatch: push: branches: [dev] + # Mirrored in .github/nix-hashes/publish.sh. paths: - "bun.lock" - "package.json" @@ -25,7 +35,7 @@ concurrency: jobs: # Native runners required: bun install cross-compilation flags (--os/--cpu) # do not produce byte-identical node_modules as native installs. - compute-hash: + hash: strategy: fail-fast: false matrix: @@ -41,6 +51,8 @@ jobs: steps: - name: Checkout repository uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + persist-credentials: false - name: Setup Nix uses: nixbuild/nix-quick-install-action@2c9db80fb984ceb1bcaa77cdda3fdf8cfba92035 # v34 @@ -87,37 +99,29 @@ jobs: path: hash.txt retention-days: 1 - update-hashes: - needs: compute-hash - if: github.event_name != 'pull_request' - runs-on: blacksmith-4vcpu-ubuntu-2404 - environment: release + # Assembles nix/hashes.json from the per-system hashes and uploads it as the only input publish accepts. + compute: + needs: hash + runs-on: ubuntu-24.04 + outputs: + changed: ${{ steps.update.outputs.changed }} steps: - name: Checkout repository uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 with: persist-credentials: false - fetch-depth: 0 - ref: ${{ github.ref_name }} - - - name: Setup git committer - uses: ./.github/actions/setup-git-committer - with: - opencode-app-id: ${{ vars.OPENCODE_APP_ID }} - opencode-app-secret: ${{ secrets.OPENCODE_APP_SECRET }} - - - name: Pull latest changes - run: | - git pull --rebase --autostash origin "$GITHUB_REF_NAME" - name: Download hash artifacts uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 with: - path: hashes + path: ${{ runner.temp }}/hashes pattern: hash-* - name: Update hashes.json + id: update + env: + HASHES: ${{ runner.temp }}/hashes run: | set -euo pipefail @@ -126,37 +130,74 @@ jobs: [ -f "$HASH_FILE" ] || echo '{"nodeModules":{}}' > "$HASH_FILE" for SYSTEM in x86_64-linux aarch64-linux aarch64-darwin; do - FILE="hashes/hash-${SYSTEM}/hash.txt" - if [ -f "$FILE" ]; then - HASH="$(tr -d '[:space:]' < "$FILE")" - echo "${SYSTEM}: ${HASH}" - jq --arg sys "$SYSTEM" --arg h "$HASH" '.nodeModules[$sys] = $h' "$HASH_FILE" > tmp.json - mv tmp.json "$HASH_FILE" - else - echo "::warning::Missing hash for ${SYSTEM}" - fi + HASH="$(tr -d '[:space:]' < "$HASHES/hash-${SYSTEM}/hash.txt")" + echo "${SYSTEM}: ${HASH}" + jq --arg sys "$SYSTEM" --arg h "$HASH" '.nodeModules[$sys] = $h' "$HASH_FILE" > tmp.json + mv tmp.json "$HASH_FILE" done cat "$HASH_FILE" + bash .github/nix-hashes/validate.sh "$HASH_FILE" - - name: Commit changes - run: | - set -euo pipefail - - HASH_FILE="nix/hashes.json" - - if [ -z "$(git status --short -- "$HASH_FILE")" ]; then - echo "No changes to commit" + if git diff --quiet -- "$HASH_FILE"; then + echo "changed=false" >> "$GITHUB_OUTPUT" echo "### Nix hashes" >> "$GITHUB_STEP_SUMMARY" echo "Status: no changes" >> "$GITHUB_STEP_SUMMARY" - exit 0 + else + echo "changed=true" >> "$GITHUB_OUTPUT" + echo "### Nix hashes" >> "$GITHUB_STEP_SUMMARY" + echo "Status: changed" >> "$GITHUB_STEP_SUMMARY" fi - git add "$HASH_FILE" - git commit -m "chore: update nix node_modules hashes" + - name: Upload hashes.json + uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 + with: + name: nix-hashes + path: nix/hashes.json + if-no-files-found: error + retention-days: 1 - git pull --rebase --autostash origin "$GITHUB_REF_NAME" - git push origin HEAD:"$GITHUB_REF_NAME" + # Runs even when compute found no change, so an open bot pull request with stale hashes is closed, not merged. + publish: + needs: compute + if: github.repository == 'anomalyco/opencode' && github.ref == 'refs/heads/dev' + runs-on: ubuntu-24.04 + concurrency: + group: bot-nix-hashes-publish + cancel-in-progress: false + permissions: + contents: write + pull-requests: write + actions: write - echo "### Nix hashes" >> "$GITHUB_STEP_SUMMARY" - echo "Status: committed $(git rev-parse --short HEAD)" >> "$GITHUB_STEP_SUMMARY" + steps: + - name: Check out publish scripts + uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + with: + ref: ${{ github.sha }} + path: trusted + sparse-checkout: /.github/nix-hashes/ + sparse-checkout-cone-mode: false + persist-credentials: false + + # Holds the push credential; only nix/hashes.json is checked out and nothing in it runs. + - name: Check out dev + uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + with: + ref: dev + path: repo + sparse-checkout: /nix/hashes.json + sparse-checkout-cone-mode: false + + - name: Download hashes.json + uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 + with: + name: nix-hashes + path: ${{ runner.temp }}/nix-hashes + + - name: Publish + working-directory: repo + run: bash ../trusted/.github/nix-hashes/publish.sh "$RUNNER_TEMP/nix-hashes/hashes.json" + env: + GH_TOKEN: ${{ github.token }} + GH_REPO: ${{ github.repository }} diff --git a/.github/workflows/check-bot-scope.yml b/.github/workflows/check-bot-scope.yml new file mode 100644 index 00000000000..c82f3d5a8b4 --- /dev/null +++ b/.github/workflows/check-bot-scope.yml @@ -0,0 +1,63 @@ +name: check-bot-scope + +# Required on dev. bot-nix-hashes.yml pushes bot/nix-hashes and auto-merges its pull request without review, so this +# fails that branch unless it changes nothing but a valid nix/hashes.json. Every other branch passes. The bot's own +# pushes start no workflows, so bot-nix-hashes.yml dispatches this; pull_request covers anyone else pushing the branch. + +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review] + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + bot-scope: + name: bot-scope + runs-on: ubuntu-24.04 + timeout-minutes: 10 + steps: + - name: Check branch + id: branch + env: + HEAD_REF: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref_name }} + run: | + if [ "$HEAD_REF" = bot/nix-hashes ]; then + echo "bot=true" >> "$GITHUB_OUTPUT" + else + echo "$HEAD_REF is not a bot branch; nothing to check" + fi + + - name: Checkout repository + if: steps.branch.outputs.bot == 'true' + uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + with: + ref: ${{ github.event.pull_request.head.sha || github.sha }} + fetch-depth: 0 + filter: blob:none + persist-credentials: false + + - name: Check changed files + if: steps.branch.outputs.bot == 'true' + env: + BASE: ${{ github.base_ref || 'dev' }} + run: | + set -euo pipefail + git fetch --no-tags --filter=blob:none origin "+refs/heads/$BASE:refs/remotes/origin/$BASE" + changed=$(git diff --name-only "origin/$BASE...HEAD") + echo "Changed files:" + echo "$changed" + if [ "$changed" != nix/hashes.json ]; then + echo "::error::bot/nix-hashes may change only nix/hashes.json" + exit 1 + fi + + # Runs dev's validator: the step above proved this branch leaves .github/ unchanged. + - name: Validate nix/hashes.json + if: steps.branch.outputs.bot == 'true' + run: bash .github/nix-hashes/validate.sh nix/hashes.json