Unpin Rust toolchain version when building old docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 42/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github-actions, rust
- Domain
- build-system, ci-cd, developer-experience
Research direction
Start by reading .rust-toolchain.toml and identify the GitHub runner configuration used to build old documentation. Check how RUSTUP_TOOLCHAIN can override the file, then decide whether stable should apply locally, in CI, or both. Done means old documentation builds without requiring separate release-specific toolchains.
Written by the indexing model from the issue text.
Description
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. 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.
- Dominant language
- Rust
- Stars
- 8
- Forks
- 5
- Avg merge
- 11h 31m
- Merged PRs (30d)
- 33
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from EnergySystemsModellingLab/MUSE2
-
bug documentation
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
EnergySystemsModellingLab/MUSE2#1367 · 1 comment ·
-
Remove the `ironing out iteration 0` prefix from debug files when the ironing out loop is turned off Openmuse xiii question
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
EnergySystemsModellingLab/MUSE2#1221 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
EnergySystemsModellingLab/MUSE2#1554 ·
-
bug
EnergySystemsModellingLab/MUSE2#1541 · 2 comments · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
EnergySystemsModellingLab/MUSE2#1526 ·
All issues in EnergySystemsModellingLab/MUSE2
Similar issues
-
bug CLI custom-model
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
rust-bitcoin/rust-bitcoin#6930 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fulcrumgenomics/ferro-hgvs#2251 ·
-
A-allocators A-docs C-enhancement T-libs
Difficulty 2/5 1-3 hours Newbie friendliness 75/100