Skip to content

Xtask #2688

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.

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 7 commits into from
Mar 14, 2025
Merged

Xtask #2688

Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .cargo/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[alias]
xtask = "run --package xtask --"
2 changes: 1 addition & 1 deletion .github/workflows/install-mdbook/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ runs:
using: composite
steps:
- name: Install mdbook
run: ./install-mdbook.sh
run: cargo xtask install-tools
shell: bash

- name: Install dependencies for mdbook-pandoc
Expand Down
6 changes: 5 additions & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ members = [
"src/unsafe-rust",
"src/user-defined-types",
"third_party/cxx/blobstore",
"xtask",
]
resolver = "2"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ cd comprehensive-rust
Then install these tools with:

```shell
bash install-mdbook.sh
cargo xtask install-tools
```

Run
Expand Down
11 changes: 0 additions & 11 deletions install-mdbook.sh

This file was deleted.

6 changes: 6 additions & 0 deletions xtask/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[package]
name = "xtask"
version = "0.1.0"
edition = "2021"

[dependencies]
69 changes: 69 additions & 0 deletions xtask/src/main.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
use std::{env, process::Command};

type DynError = Box<dyn std::error::Error>;

fn main() {
if let Err(e) = execute_task() {
eprintln!("{e}");
std::process::exit(-1);
}
}

fn execute_task() -> Result<(), DynError> {
let task = env::args().nth(1);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already depend on Clap, so you could use it here (feel free to do this in a later PR!).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have pushed a new PR (#2707) for this and the other suggestions.

match task.as_deref() {
Some("install-tools") => install_tools()?,
_ => {
return Err(Box::from(get_help_string(task.as_deref())));
}
}
Ok(())
}

fn install_tools() -> Result<(), DynError> {
println!("Installing project tools...");

let install_args: Vec<Vec<&str>> = vec![
// The --locked flag is important for reproducible builds. It also
// avoids breakage due to skews between mdbook and mdbook-svgbob.
vec!["mdbook", "--locked", "--version", "0.4.44"],
vec!["mdbook-svgbob", "--locked", "--version", "0.2.1"],
vec!["mdbook-pandoc", "--locked", "--version", "0.9.3"],
vec!["mdbook-i18n-helpers", "--locked", "--version", "0.3.5"],
vec!["i18n-report", "--locked", "--version", "0.2.0"],
// These packages are located in this repository
vec!["--path", "mdbook-exerciser", "--locked"],
vec!["--path", "mdbook-course", "--locked"],
];

for args in &install_args {
let status = Command::new(env!("CARGO"))
.arg("install")
.args(args)
.status()
.expect("Failed to execute cargo install");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious: have you tested how the errors look if you provoke an error? Like by installing something which doesn't exist?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I tested manually the various scenarios (missing task, unkown task, and internal error e.g. typo 'mdbok instead of mdbook' in the install-tools logic). We get appropriate error messages and behaviour in each case.


if !status.success() {
let error_message = format!(
"Command 'cargo install {}' exited with status code: {}",
args.join(" "),
status.code().unwrap()
);
return Err(Box::from(error_message));
}
}

Ok(())
}

fn get_help_string(task: Option<&str>) -> String {
if let Some(t) = task {
format!(
"Unrecognized task '{t}'. Available tasks:

install-tools Installs the tools the project depends on."
)
} else {
"Missing task. To execute a task run `cargo xtask [task]`.".to_string()
}
}