EnergySystemsModellingLab / EnergySystemsModellingLab/MUSE2

Unpin Rust toolchain version when building old docs

Aperta
#1,192 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation question
Lingua principale
Rust
Stelle
8
Fork
5
Merge medio
1g 2m
PR unite (30g)
37

Descrizione

We pin the Rust toolchain by way of a `.rust-toolchain.toml` file, but we mostly do so to make sure devs are all using the latest version. Rust has good backwards compatibility (often new functions etc. are added, but old code should compile with new compilers), so the latest version of the toolchain should be fine. In future, we will probably have a different pinned version of the toolchain for _every_ release and making users/GitHub runners download all of them seems silly.

It seems you can tell `rustup` to use a specific version of the toolchain [by setting the `RUSTUP_TOOLCHAIN` environment variable](https://rust-lang.github.io/rustup/overrides.html). This will override the setting in `.rust-toolchain.toml`, if any. We probably just want to set it to `stable`.

It's debateable whether we should make this a policy that is enforced both locally on CI or just on CI. Personally, I think we should probably be consistent and use `stable` for both.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo .rust-toolchain.toml e identifica la configurazione del GitHub runner usata per compilare la documentazione precedente. Verifica in che modo RUSTUP_TOOLCHAIN può sovrascrivere il file, quindi decidi se stable debba essere applicato localmente, in CI o in entrambi. Il lavoro è completato quando la documentazione precedente viene compilata senza richiedere toolchain separate specifiche per ogni release.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, rust
Ambito
build-system, ci-cd, developer-experience
Tipo di issue
Refactoring
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.