All checks were successful
PR Checks / rust-gates (pull_request) Successful in 4m2s
actions/cache restored the previous target/ through restore-keys and re-saved all of it under every new Cargo.lock hash, so each entry carried every older build and the runner's cache grew without bound. Swatinem/rust-cache strips the crate's own and stale artifacts before saving and saves only on a miss. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY
121 lines
5.7 KiB
YAML
121 lines
5.7 KiB
YAML
# Gate every pull request into `main` on the same Rust checks the release runs,
|
|
# so a formatting slip, a lint regression, or a failing test can't reach the
|
|
# deployable branch.
|
|
#
|
|
# Mirrors RunicGateway/link's pr-checks.yml — same gates in the same order as
|
|
# release.yml, so a green PR means the release will get past its own gates too.
|
|
# The one structural difference is the crate guard below.
|
|
#
|
|
# ── Crate guard ──────────────────────────────────────────────────────────────
|
|
# The gates are conditional on a root Cargo.toml existing: before the crate
|
|
# landed, this job reported green with a notice so governance/docs PRs were not
|
|
# red-Xed by a workflow with nothing to build. Phase 1 has now added the crate on
|
|
# `edge`, so the gates arm themselves there automatically — and stay dormant on
|
|
# a `main` PR until the cutover merges the crate into it. Nothing here changes at
|
|
# that point either.
|
|
#
|
|
# The crate is expected at the REPO ROOT (not a subdirectory like link/sidecar):
|
|
# this repo's sole product is the one installer binary, so there is nothing to
|
|
# namespace it against.
|
|
#
|
|
# Enforcement (one-time, in the Gitea UI):
|
|
# Repository Settings → Branches → Branch Protection (rule for `main`)
|
|
# • Enable Status Check
|
|
# • Status check patterns: PR Checks / *
|
|
# Note: Gitea only lists a context in its dropdown after it has reported once,
|
|
# so let this workflow run on one PR first. The `PR Checks / *` glob matches
|
|
# without needing the dropdown.
|
|
#
|
|
# Runner: the same self-hosted `ubuntu-latest` runner release.yml uses. Rust is
|
|
# not assumed to be preinstalled, so the toolchain step bootstraps it the same
|
|
# way release.yml does (minus the MinGW cross-compile deps — PRs build for the
|
|
# host only; the Windows cross-build stays a release-time concern).
|
|
|
|
name: PR Checks
|
|
|
|
on:
|
|
pull_request:
|
|
# `edge` is gated as well as `main`. Phase 1 and 2 land there rather than on `main` so that
|
|
# release.yml — which fires on every push to `main` — does not publish an installer binary that
|
|
# can deploy the overlay but not yet install the sidecar. Ungating the branch where all the
|
|
# work actually happens would leave the gates running only at the cutover, which is the one
|
|
# moment a red build is most expensive.
|
|
branches: [main, edge]
|
|
|
|
# A newer push to the same PR cancels the in-flight run.
|
|
concurrency:
|
|
group: pr-checks-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
rust-gates:
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Detect whether a crate exists yet
|
|
id: detect
|
|
run: |
|
|
set -euo pipefail
|
|
if [ -f Cargo.toml ]; then
|
|
echo "crate=true" >> "$GITHUB_OUTPUT"
|
|
echo "==> Cargo.toml found — running the full gate set."
|
|
else
|
|
echo "crate=false" >> "$GITHUB_OUTPUT"
|
|
echo "==> No Cargo.toml at the repo root yet (planning phase)."
|
|
echo " Skipping fmt/clippy/test. These gates arm themselves as"
|
|
echo " soon as Phase 1 lands the crate — see docs/installer/PLAN.md."
|
|
fi
|
|
|
|
# One job runs all three gates on purpose: installing the toolchain costs
|
|
# far more than the checks themselves, so splitting fmt/clippy/test into
|
|
# parallel jobs would pay that cost three times for no wall-clock win.
|
|
- name: Install Rust toolchain (rustfmt + clippy)
|
|
if: ${{ steps.detect.outputs.crate == 'true' }}
|
|
run: |
|
|
set -euo pipefail
|
|
SUDO=""; [ "$(id -u)" -ne 0 ] && SUDO="sudo"
|
|
$SUDO apt-get update
|
|
$SUDO apt-get install -y --no-install-recommends \
|
|
build-essential curl ca-certificates git
|
|
|
|
if ! command -v cargo >/dev/null 2>&1; then
|
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs \
|
|
| sh -s -- -y --profile minimal --default-toolchain stable
|
|
fi
|
|
echo "${HOME}/.cargo/bin" >> "$GITHUB_PATH"
|
|
export PATH="${HOME}/.cargo/bin:${PATH}"
|
|
rustup component add rustfmt clippy
|
|
cargo --version && cargo fmt --version && cargo clippy --version
|
|
|
|
# Dependency builds are reused until a dep actually changes; a cache miss
|
|
# only makes the run slower, never wrong. rust-cache rather than a plain
|
|
# actions/cache of target/: it strips this crate's own artifacts and
|
|
# anything stale before saving, and saves only on a miss. The plain cache
|
|
# restored the previous target/ and re-saved all of it under every new
|
|
# Cargo.lock, so each entry carried every older build and the runner's
|
|
# cache grew without bound.
|
|
- name: Cache cargo registry and dependency builds
|
|
if: ${{ steps.detect.outputs.crate == 'true' }}
|
|
uses: Swatinem/rust-cache@v2
|
|
|
|
# Cheapest gate first — parses only, no compile, so a formatting slip
|
|
# fails in seconds instead of after a full build.
|
|
- name: cargo fmt --check
|
|
if: ${{ steps.detect.outputs.crate == 'true' }}
|
|
run: cargo fmt --check
|
|
|
|
# --all-targets covers tests and examples, not just the binary.
|
|
# -D warnings makes a lint a failure, so the crate starts clean at this bar
|
|
# and anything new is a regression introduced by the PR.
|
|
- name: cargo clippy
|
|
if: ${{ steps.detect.outputs.crate == 'true' }}
|
|
run: cargo clippy --locked --all-targets -- -D warnings
|
|
|
|
# --locked matches release.yml: it also proves Cargo.lock is in sync with
|
|
# Cargo.toml, rather than letting the build silently update it.
|
|
- name: cargo test
|
|
if: ${{ steps.detect.outputs.crate == 'true' }}
|
|
run: cargo test --locked
|