chore(ci): pin the Rust toolchain, so a clippy or rustfmt release cannot turn lint red with no code change

Offen
  • Stimmt etwas nicht?
#92 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
55/100
Issue-Typ
Refactoring
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, rust, wasm
Bereich
build-system, ci-cd

Rechercherichtung

Start with .github/actions/setup-rust/action.yml, scripts/rs, .github/scripts/classify-changes.sh, and docs/src/architecture/cicd.md to trace how CI, local commands, and documentation select Rust. Check how the Worker wasm32 build uses worker-build and wrangler, then verify the acceptance criteria, including the throwaway pin-change control. Done means one exact version drives repository commands and CI, jobs report the compiler version, and docs/ explains the bump process.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

area:process prio:p1

Context

CI installs the Rust toolchain as stable (.github/actions/setup-rust/action.yml:34, through dtolnay/rust-toolchain). There is no rust-toolchain or rust-toolchain.toml file, and no rust-version in any manifest. scripts/rs also hard-codes stable (scripts/rs:20, rustup which --toolchain stable rustc). Locally, Homebrew's cargo 1.98.1 comes first on PATH while rustup's stable is 1.99.0 (its header records this, measured 2026-10-18), so a bare cargo and scripts/rs cargo are different compilers.

The lint job added by #87 runs cargo clippy ... -- -D warnings. Clippy adds lints in most releases, so on a floating toolchain a new stable release will eventually turn lint red with no change to the code. No such release has happened yet: the 47 warnings that #87 had to fix first were there because clippy had never run in CI, not because a release moved. That is why this is a risk to remove now, not an incident to fix.

Problem

  • A rustc, clippy or rustfmt release breaks lint (and can change fmt --check) on whichever pull request lands next, and on main.
  • CI and a developer's machine can disagree about which lints exist.
  • There is no single place that says which compiler this repository is built and tested with.

Proposal

  • A rust-toolchain.toml naming an exact version, with the components (clippy, rustfmt) and the wasm32-unknown-unknown target. Decide how CI installs it (read the version from the file, or let rustup honour the file) so the version lives in one place.
  • Make scripts/rs follow the pin instead of stable.
  • Write down how the pin is bumped. Dependabot does not bump rustc, so this is a deliberate, small pull request (or a scheduled one): bump, run cargo clippy --fix for new lints, and land them together, instead of finding them on an unrelated pull request.
  • Check it against the other pins that move with the compiler: worker-build 0.8.7 and wrangler 4.151.2 (both in the setup-rust action) and the Worker's wasm32 build.
  • Keep it separate from an MSRV (rust-version), which is a different question and not set today.

classify-changes.sh already treats a path starting rust-toolchain as Rust, so a change to the pin runs the Rust jobs.

Acceptance criteria

  • One file defines the version, and CI, scripts/rs and a plain cargo in the repository all use it. Each CI job prints the rustc --version it used.
  • The control: change the pin to a different version on a throwaway branch, and the jobs report that version (and nothing else moves).
  • The bump procedure is written down in docs/.
  • docs/src/architecture/cicd.md ("the Rust toolchain is stable, not pinned, so a new clippy or rustfmt release can fail lint") is updated to say what is pinned and how to bump it.

References

#40, #87; .github/actions/setup-rust/action.yml; scripts/rs; .github/scripts/classify-changes.sh; docs/src/architecture/cicd.md, "Permissions and supply chain".

Vorherrschende Sprache
Rust
Sterne
0
Forks
0
Ø Merge
1 Std. 35 Min.
Gemergte PRs (30 T.)
67

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus aRustyDev/thrust

Alle Issues in aRustyDev/thrust

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.