ci: extract shared setup-rust and setup-sp1 composite actions#141
Open
prajwolrg wants to merge 2 commits into
Open
ci: extract shared setup-rust and setup-sp1 composite actions#141prajwolrg wants to merge 2 commits into
prajwolrg wants to merge 2 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
The clippy job runs `--all-features`, which pulls `sp1-core-executor-runner`
into the lint graph. Its build.rs runs a nested `cargo build` and embeds the
result via `include_bytes!(env!("SP1_CORE_RUNNER_BINARY"))`. Since clippy runs
build scripts, that native build executes even for a lint, and it breaks on a
`Swatinem/rust-cache` hit: the helper binary lives under the registry source
dir (not preserved by the cache), while the build-script output recording its
path is cached, so cargo skips the rebuild and `include_bytes!` can't read it.
The crate's build.rs honors a `SP1_CORE_RUNNER_OVERRIDE_BINARY` env var
(source-only; not in its README/docs): when set it skips the nested build and
points the runtime at an external binary instead. A `prebuild-sp1-runner`
composite action pre-builds the helper into `$RUNNER_TEMP` and returns its
path as an output; lint.yml and prover.yml set it as the override env only on
the steps that compile the crate. Returning a path rather than writing
`$GITHUB_ENV` keeps the override scoped to those steps instead of the whole
job. This is cache-stable and keeps the heavy build out of the lint, unlike
the previous `cargo clean` workaround it replaces in prover.yml.
The helper version is read from Cargo.lock, not the `sp1-sdk` requirement,
which is a caret that floats up to a later patch in the lock.
prajwolrg
force-pushed
the
ci-exclude-sp1-from-clippy
branch
from
ce40d6b to
7c9c43f
Compare
Every workflow repeated the same Rust setup (toolchain install + Swatinem cache + protoc) with only small variations, and prover/release duplicated the SP1 toolchain install + version check verbatim. That spread the pinned action SHAs and the rust-toolchain.toml parse across nine jobs, so a bump had to be made in many places. Factor the setup into two local composite actions: - `setup-rust` (inputs: channel, components, cache, protoc) — installs the toolchain and, by default, restores the cache and installs protoc. `channel: rust-toolchain.toml` reads the pinned channel from that file. - `setup-sp1` — sp1up install + PATH + `cargo prove --version`. Behavior is preserved per job via inputs: components (clippy/rustfmt/ llvm-tools-preview), cache disabled for the fmt and release jobs, protoc disabled for the fmt and security jobs, and the rust-toolchain.toml channel for prover/release. Every input combination release.yml uses is also exercised by a PR-triggered job, so the tag-only release workflow is covered indirectly. setup-sp1 carries a `zizmor: ignore[github-env]` for its $GITHUB_PATH append: persisting $HOME/.sp1/bin onto PATH for later steps requires $GITHUB_PATH and the value is fixed and trusted. zizmor flags env-file writes in composite actions (context-agnostic) even though the same write was unflagged inline in the workflows.
prajwolrg
force-pushed
the
ci-rust-composite-actions
branch
from
dcaf346 to
e013da1
Compare
|
Commit: 0c61f91
|
Member
|
This is very useful. I think we should move this to |
Collaborator
Author
Thanks. We can do that if it's useful, although I'm not sure how would that actually work. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Stacked on #140 (base branch
ci-exclude-sp1-from-clippy); will retarget tomainonce #140 merges.Every workflow repeated the same Rust setup (toolchain install +
Swatinem/rust-cache+arduino/setup-protoc) with only small variations, andprover.yml/release.ymlduplicated the SP1 toolchain install +cargo prove --versioncheck verbatim. The pinned action SHAs and therust-toolchain.tomlparse were spread across nine jobs.This extracts the setup into two local composite actions:
.github/actions/setup-rust(inputs:channel,components,cache,protoc) — installs the toolchain and, by default, restores the cache and installs protoc.channel: rust-toolchain.tomlreads the pinned channel from that file..github/actions/setup-sp1— sp1up install + PATH +cargo prove --version.Per-job behavior is preserved via inputs:
Type of Change
Notes to Reviewers
release.ymlonly runs on tags, so it isn't exercised by PR CI. But every input combination it uses (channel: rust-toolchain.toml,cache: "false") is also used by a PR-triggered job (prover, lint/fmt), so the composite is covered indirectly.$GITHUB_PATHpropagation is relied on insetup-sp1(the version-check step reads the PATH set by the install step) — confirmed by the prover-perf job going green.Related Issues
Jira: STR-3722 (CI cleanup split out of the manifest-MMR reorg work; follow-up to #140).