Skip to content

Speed up rust crate installs in workflow by using cargo-binstall #2915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 19, 2025
Merged

Speed up rust crate installs in workflow by using cargo-binstall #2915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fc632e
implement "--binstall" argument to allow cargo xtasks install-tools t…
michael-kerscher Sep 16, 2025
156396a
Let cargo xtask install-tools use cargo-binstall.
michael-kerscher Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/install-mdbook/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ description: Install mdbook with the dependencies we need.
runs:
using: composite
steps:
- name: Ensure cargo-binstall is installed
uses: cargo-bins/cargo-binstall@main

- name: Install mdbook
run: cargo xtask install-tools
run: cargo xtask install-tools --binstall
shell: bash

- name: Install dependencies for mdbook-pandoc
Expand Down
18 changes: 13 additions & 5 deletions xtask/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,11 @@ struct Cli {
#[derive(Subcommand)]
enum Task {
/// Installs the tools the project depends on.
InstallTools,
InstallTools {
/// Use cargo-binstall for faster installation.
#[arg(long)]
binstall: bool,
},
/// Runs the web driver tests in the tests directory.
WebTests {
/// Optional 'book html' directory - if set, will also refresh the list
Expand Down Expand Up @@ -79,7 +83,7 @@ enum Task {
fn execute_task() -> Result<()> {
let cli = Cli::parse();
match cli.task {
Task::InstallTools => install_tools(),
Task::InstallTools { binstall } => install_tools(binstall),
Task::WebTests { dir } => run_web_tests(dir),
Task::RustTests => run_rust_tests(),
Task::Serve { language, output } => start_web_server(language, output),
Expand All @@ -105,9 +109,13 @@ fn run_command(cmd: &mut Command) -> Result<()> {
Ok(())
}

fn install_tools() -> Result<()> {
fn install_tools(binstall: bool) -> Result<()> {
println!("Installing project tools...");

let cargo = env!("CARGO");

let install_command = if binstall { "binstall" } else { "install" };

const PINNED_NIGHTLY: &str = "nightly-2025-09-01";

// Install rustup components
Expand All @@ -121,7 +129,6 @@ fn install_tools() -> Result<()> {
run_command(&mut cmd)?;
}

let cargo = env!("CARGO");
// The --locked flag is important for reproducible builds.
let tools = [
("mdbook", "0.4.52"),
Expand All @@ -134,12 +141,13 @@ fn install_tools() -> Result<()> {

for (tool, version) in tools {
let mut cmd = Command::new(cargo);
cmd.args(["install", tool, "--version", version, "--locked"]);
cmd.args([install_command, tool, "--version", version, "--locked"]);
run_command(&mut cmd)?;
}

// Install local tools from the workspace.
let workspace_dir = Path::new(env!("CARGO_WORKSPACE_DIR"));
// cargo-binstall does not support --path, so we always use cargo install here.
let local_tools = ["mdbook-exerciser", "mdbook-course"];
for tool in local_tools {
let mut cmd = Command::new(cargo);
Expand Down