Skip to content

Commit 02fa301

Browse files
authored
docs: restore the SP1 repository home README (#3009)
1 parent f2baa76 commit 02fa301

2 files changed

Lines changed: 21 additions & 20 deletions

File tree

‎.github/README.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎DEVELOPMENT.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,27 @@ cargo install mdbook # Installs mdbook locally
5858
mdbook serve # Serves the docs locally
5959
```
6060

61+
## PR workflow runners
62+
63+
The `PR` workflow uses the `ci-v3` RunsOn environment when the repository variable `SP1_CI_RUNS_ON_ENVIRONMENT` is empty.
64+
Set this variable to `legacy` to select the existing runners for new ordinary jobs.
65+
To select another RunsOn environment for ordinary PR, push, and merge-group jobs, set this variable to its environment name.
66+
Prepare that environment before you set the variable.
67+
The selected environment uses a `150gb:gp3:750mbps:4000iops` root volume.
68+
GPU jobs keep their instance type and AMI.
69+
70+
The GitHub-hosted `Runner routing` job validates the selection before the nine RunsOn jobs can start.
71+
An invalid environment name or volume fails that check.
72+
The variable affects only this workflow.
73+
74+
Manual runs use their `runs_on_environment` and `runs_on_volume` inputs independently of the repository variable.
75+
An empty manual environment input selects the legacy runners.
76+
77+
Clear `SP1_CI_RUNS_ON_ENVIRONMENT` to restore the `ci-v3` default for new ordinary runs.
78+
This does not move jobs that already have runner labels or stop their instances.
79+
80+
Run `ruby .github/scripts/check-runner-routing.rb` to check the default, legacy, configured, and manual routes locally.
81+
6182
## Publishing
6283

6384
SP1 crates are hosted on [crates.io](https://crates.io/search?q=sp1). We use

0 commit comments

Comments
 (0)