Skip to content

GitHub Action for installing development tools (mainly from GitHub Releases).

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

taiki-e/install-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

install-action

release github actions

GitHub Action for installing development tools (mainly from GitHub Releases).

Usage

Inputs

Name Required Description Type Default
tool true Tools to install (comma-separated list) String
checksum false Whether to enable checksums Boolean true

Example workflow

To install the latest version:

- uses: taiki-e/install-action@v2
  with:
    tool: cargo-hack

You 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-hack

To install a specific version, use @version syntax:

- uses: taiki-e/install-action@v2
  with:
    tool: cargo-hack@0.5.24

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: cargo-hack@0.5

To install multiple tools:

- uses: taiki-e/install-action@v2
  with:
    tool: cargo-hack,cargo-minimal-versions

Or:

- uses: taiki-e/install-action@cargo-hack
- uses: taiki-e/install-action@cargo-minimal-versions

Supported tools

See TOOLS.md for the list of tools that are installed from manifests managed in this action.

If a tool not included in the list above is specified, this action uses cargo-binstall as a fallback.

If you want to ensure that fallback is not used, use fallback: none.

- uses: taiki-e/install-action@v2
  with:
    tool: cargo-hack
    # Possible values:
    # - none: disable all fallback
    # - cargo-binstall (default): cargo-binstall (includes quickinstall)
    fallback: none

Add support for new tool

See the development guide for how to add support for new tool.

Security

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.

See the Supported tools section for how to ensure that fallback is not used.

Compatibility

This action has been tested for GitHub-hosted runners (Ubuntu, macOS, Windows) and containers (Ubuntu, Debian, Fedora, CentOS, Alma, openSUSE, Arch, Alpine).

On Linux, if any required tools are missing, this action will attempt to install them from distro's package manager, so no pre-setup is usually required (except for CentOS or Debian 9 (or older) or very old distro described below, which was already EoL and needs to use vault/archive repos -- see "Install requirements" in our CI config for example of setup).

On other platforms, at least the following tools are required:

  • bash 3.2+
  • jq 1.3+
  • curl 7.34+ (or RHEL7/CentOS7's patched curl 7.29)

Known environments affected by the above version requirements are CentOS 6 (EoL on 2020-11) using curl 7.19, and Ubuntu 12.04 (EoL on 2017-04) using curl 7.22 (see "Install requirements" in our CI config for example of workaround).

Related Projects

License

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.

About

GitHub Action for installing development tools (mainly from GitHub Releases).

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Code of conduct

Stars

Watchers

Forks

Sponsor this project