GitHub Action for installing development tools (mainly from GitHub Releases).
| Name | Required | Description | Type | Default |
|---|---|---|---|---|
| tool | true | Tools to install (comma-separated list) | String | |
| checksum | false | Whether to enable checksums | Boolean | true |
To install the latest version:
- uses: taiki-e/install-action@v2
with:
tool: cargo-hackYou can use the shorthand (if you do not need to pin the versions of this action and the installed tool):
- uses: taiki-e/install-action@cargo-hackTo install a specific version, use @version syntax:
- uses: taiki-e/install-action@v2
with:
tool: [email protected]You can also omit patch version. (You can also omit the minor version if the major version is 1 or greater.)
- uses: taiki-e/install-action@v2
with:
tool: [email protected]To install multiple tools:
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack,cargo-minimal-versionsOr:
- uses: taiki-e/install-action@cargo-hack
- uses: taiki-e/install-action@cargo-minimal-versions| Name | Where binaries will be installed | Where will it be installed from | Supported platform | License |
|---|---|---|---|---|
| biome | /usr/local/bin |
GitHub Releases | Linux, macOS, Windows | MIT |
| cargo-audit | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-binstall | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | GPL-3.0 |
| cargo-careful | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-cyclonedx | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 |
| cargo-deny | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-dinghy | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS | Apache-2.0 OR MIT |
| cargo-export | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MIT |
| cargo-hack | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-llvm-cov | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-machete | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MIT |
| cargo-make | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 |
| cargo-minimal-versions | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-no-dev-deps | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-rdme | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MPL-2.0 |
| cargo-sort | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-spellcheck | $CARGO_HOME/bin |
GitHub Releases | Linux and Windows | LGPLv2.1 |
| cargo-tarpaulin | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-udeps | $CARGO_HOME/bin |
GitHub Release | Linux, macOS, Windows | Apache-2.0 OR MIT |
| cargo-valgrind | $CARGO_HOME/bin |
GitHub Release | Linux, macOS, Windows | MIT or Apache-2.0 |
| cross | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| dprint | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MIT |
| git-cliff | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| grcov | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MPL-2.0 |
| hyperfine | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MIT or Apache-2.0 |
| just | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | CC0-1.0 |
| mdbook-linkcheck | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MIT |
| mdbook | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MPL-2.0 |
nextest (alias: cargo-nextest) |
$CARGO_HOME/bin |
cargo-binstall | Linux, macOS, Windows | Apache-2.0 OR MIT |
| osv-scanner | /usr/local/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2 |
| parse-changelog | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| protoc | $HOME/.install-action/bin |
GitHub Releases | Linux, macOS, Windows | BSD-3-Clause |
| sccache | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 |
| shellcheck | /usr/local/bin |
GitHub Releases | Linux, macOS, Windows | GPL-3.0-or-later |
| shfmt | /usr/local/bin |
GitHub Releases | Linux, macOS, Windows | BSD-3-Clause |
| syft | /usr/local/bin |
Github Releases | Linux, macOS, Windows | Apache-2.0 |
| typos | $CARGO_HOME/bin |
Github Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| valgrind | /snap/bin |
snap | Linux | GPL-2.0-or-later |
| wasm-bindgen | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| wasm-pack | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| wasmtime | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 WITH LLVM-exception |
| xbuild | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | Apache-2.0 OR MIT |
| zola | $CARGO_HOME/bin |
GitHub Releases | Linux, macOS, Windows | MIT |
If $CARGO_HOME/bin is not available, Rust-related binaries will be installed to $HOME/.cargo/bin.
If $HOME/.cargo/bin is not available, Rust-related binaries will be installed to /usr/local/bin.
If /usr/local/bin is not available, binaries will be installed to $HOME/.install-action/bin.
If a tool not included in the list above is specified, this action uses cargo-binstall as a fallback.
See the development guide for how to add support for new tool.
When installing the tool from GitHub Releases, this action will download the tool or its installer from GitHub Releases using HTTPS with tlsv1.2+. This is basically considered to be the same level of security as the recommended installation of rustup.
Additionally, this action will also verify SHA256 checksums for downloaded files in all tools installed from GitHub Releases. This is enabled by default and can be disabled by setting the checksum input option to false.
Additionally, we also verify signature if the tool distributes signed archives. Signature verification is done at the stage of getting the checksum, so disabling the checksum will also disable signature verification.
See the linked documentation for information on security when installed using snap or cargo-binstall.
This action has been tested for GitHub-hosted runners (Ubuntu, macOS, Windows) and containers (Ubuntu, Debian, Alpine, Fedora, CentOS, Alma). To use this action in self-hosted runners or in containers, at least the following tools are required:
- bash
- cargo (if you use cargo-binstall fallback)
- cache-cargo-install-action: GitHub Action for
cargo installwith cache. - create-gh-release-action: GitHub Action for creating GitHub Releases based on changelog.
- upload-rust-binary-action: GitHub Action for building and uploading Rust binary to GitHub Releases.
- setup-cross-toolchain-action: GitHub Action for setup toolchains for cross compilation and cross testing for Rust.
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Each of the tools installed by this action has a different license. See the Supported tools section for more information.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.