The toml workflow job will now install taplo-cli using cargo-binstall #18773
Conversation
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
alice-i-cecile
added
A-Build-System
alice-i-cecile
approved these changes
Apr 9, 2025
|
I proposed to use |
mockersf
reviewed
Apr 9, 2025
Co-authored-by: François Mockers <francois.mockers@vleue.com>
TrialDragon
suggested changes
Apr 13, 2025
TrialDragon
approved these changes
Apr 17, 2025
TrialDragon
added
S-Ready-For-Final-Review
andrewzhurov
pushed a commit
to andrewzhurov/bevy
that referenced
this pull request
May 17, 2025
…bevyengine#18773) # Objective Avoid needing to compile `taplo-cli` every time we use it in CI. ## Solution Use [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) to install `taplo-cli`. cargo-binstall is different from `cargo install`, in that it will first attempt download a precompiled `taplo-cli` binary, in an attempt to avoid compilation. However, failing that (for any reason), it will fall back to installing the binary through `cargo install`. While installing `taplo-cli` from source is relatively fast (around 50-60s), this still provides a small speed boost to the job, by not needing to spend time compiling `taplo-cli` from source at all. ## Note on how this affects workflows This PR does have one side-effect: Should `taplo-cli` need to be compiled from source at all, it is no longer guaranteed to use the latest `stable` version of `rustc`. This may be considered problematic, as `taplo-cli` doesn't appear to have a MSRV policy. However, its MSRV (as of writing this PR) is `1.74` - a nearly 1.5 year old version. This seems to imply that, if `taplo-cli`'s MSRV is ever updated, it won't be to the absolute latest stable version of Rust until said version is a few months old. Combine that with [the Github Actions runner images being frequently (and automatically) updated to use the latest Rust tooling](actions/runner-images#11957), and I don't foresee `taplo-cli`'s MSRV being an issue in 99% of circumstances. Still, there is the possibility of it being a problem in those 1% of circumstances - if this is a concern, please let me know and I'll try to fix it. ## Testing This change was tested on my local fork. The specific job run can be found [here](https://github.com/LikeLakers2/bevy/actions/runs/14350945588/job/40229485624). --------- Co-authored-by: François Mockers <francois.mockers@vleue.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Objective
Avoid needing to compile
taplo-clievery time we use it in CI.Solution
Use cargo-binstall to install
taplo-cli.cargo-binstall is different from
cargo install, in that it will first attempt download a precompiledtaplo-clibinary, in an attempt to avoid compilation. However, failing that (for any reason), it will fall back to installing the binary throughcargo install.While installing
taplo-clifrom source is relatively fast (around 50-60s), this still provides a small speed boost to the job, by not needing to spend time compilingtaplo-clifrom source at all.Note on how this affects workflows
This PR does have one side-effect: Should
taplo-clineed to be compiled from source at all, it is no longer guaranteed to use the lateststableversion ofrustc. This may be considered problematic, astaplo-clidoesn't appear to have a MSRV policy.However, its MSRV (as of writing this PR) is
1.74- a nearly 1.5 year old version. This seems to imply that, iftaplo-cli's MSRV is ever updated, it won't be to the absolute latest stable version of Rust until said version is a few months old.Combine that with the Github Actions runner images being frequently (and automatically) updated to use the latest Rust tooling, and I don't foresee
taplo-cli's MSRV being an issue in 99% of circumstances.Still, there is the possibility of it being a problem in those 1% of circumstances - if this is a concern, please let me know and I'll try to fix it.
Testing
This change was tested on my local fork. The specific job run can be found here.