https://github.com/taiki-e/cache-cargo-install-action
GitHub Action for `cargo install` with cache.
https://github.com/taiki-e/cache-cargo-install-action
github-actions rust
Last synced: 4 months ago
JSON representation
GitHub Action for `cargo install` with cache.
- Host: GitHub
- URL: https://github.com/taiki-e/cache-cargo-install-action
- Owner: taiki-e
- License: apache-2.0
- Created: 2023-01-13T16:18:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-28T06:39:43.000Z (about 2 years ago)
- Last Synced: 2024-05-01T23:58:15.196Z (about 2 years ago)
- Topics: github-actions, rust
- Language: Shell
- Homepage:
- Size: 73.2 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# cache-cargo-install-action
[](https://github.com/taiki-e/cache-cargo-install-action/releases/latest)
[](https://github.com/taiki-e/cache-cargo-install-action/actions)
GitHub Action for `cargo install` with cache.
This installs the specified crate using `cargo install` and caches the installed binaries using [actions/cache].
If binaries for the specified crate are already cached, restore the cache instead of calling `cargo install`.
This was originally intended for installing crates that are not supported by [install-action].
For performance and robustness, we recommend using [install-action] if the tool is supported by [install-action].
- [Usage](#usage)
- [Inputs](#inputs)
- [Example workflow](#example-workflow)
- [Migrate from/to install-action](#migrate-fromto-install-action)
- [Compatibility](#compatibility)
- [Related Projects](#related-projects)
- [License](#license)
## Usage
### Inputs
| Name | Required | Description | Type | Default |
| ---- | :------: | ----------- | ---- | ------- |
| tool | **✓** | Crate to install | String | |
| locked | | Use `--locked` flag | Boolean | true |
| git | | Install from the specified Git URL (see [action.yml](action.yml) for more) | String | |
| tag | | Tag to use when installing from git | String | |
| rev | | Specific commit to use when installing from git | String | |
| features | | Comma-separated list of features to enable when installing the crate | String | |
| no-default-features | | Pass `--no-default-features` to `cargo install` | Boolean | false |
| all-features | | Pass `--all-features` to `cargo install` | Boolean | false |
### Example workflow
To install the latest version:
```yaml
- uses: taiki-e/cache-cargo-install-action@v3
with:
tool: cargo-hack
```
To install a specific version, use `@version` syntax:
```yaml
- uses: taiki-e/cache-cargo-install-action@v3
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.)
```yaml
- uses: taiki-e/cache-cargo-install-action@v3
with:
tool: cargo-hack@0.5
```
## Migrate from/to install-action
This action provides an interface compatible with [install-action].
Therefore, migrating from/to [install-action] is usually just a change of action to be used. (if the tool and version are supported by install-action or install-action's `binstall` fallback)
To migrate from this action to install-action:
```diff
- - uses: taiki-e/cache-cargo-install-action@v3
+ - uses: taiki-e/install-action@v2
with:
tool: cargo-hack
```
To migrate from install-action to this action:
```diff
- - uses: taiki-e/install-action@v2
+ - uses: taiki-e/cache-cargo-install-action@v3
with:
tool: cargo-hack
```
The interface of this action is a subset of the interface of [install-action], so note the following limitations when migrating from install-action to this action.
- install-action supports specifying multiple crates in a single action call, but this action does not.
For example, in install-action, you can write:
```yaml
- uses: taiki-e/install-action@v2
with:
tool: cargo-hack,cargo-minimal-versions
```
In this action, you need to write:
```yaml
- uses: taiki-e/cache-cargo-install-action@v3
with:
tool: cargo-hack
- uses: taiki-e/cache-cargo-install-action@v3
with:
tool: cargo-minimal-versions
```
- install-action supports `@` shorthand, but this action does not.
## Compatibility
This action has been tested for GitHub-hosted runners (Ubuntu, macOS, Windows) and containers (Ubuntu, Debian, Fedora, Alma, Arch, Alpine).
To use this action in self-hosted runners or in containers, at least the following tools are required:
- cargo
On Linux, if other required tools are missing, this action will attempt to install them from distro's package manager, so no pre-setup is usually required.
On other platforms, the following tools are also required:
- bash
- jq (only on non-Windows platforms, and when installing the latest version or the patch version of the specified version is omitted)
- curl (only when installing the latest version or the patch version of the specified version is omitted)
- tar
Note that what this action installs for its setup (such as above tools) is considered an implementation detail if they are installed by this action's side, and there is no guarantee that they will be available in subsequent steps, because this action is not an action for installing those tools.
## Related Projects
- [install-action]: GitHub Action for installing development tools (mainly from GitHub Releases).
- [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.
- [checkout-action]: GitHub Action for checking out a repository. (Simplified actions/checkout alternative that does not depend on Node.js.)
[actions/cache]: https://github.com/actions/cache
[checkout-action]: https://github.com/taiki-e/checkout-action
[create-gh-release-action]: https://github.com/taiki-e/create-gh-release-action
[install-action]: https://github.com/taiki-e/install-action
[setup-cross-toolchain-action]: https://github.com/taiki-e/setup-cross-toolchain-action
[upload-rust-binary-action]: https://github.com/taiki-e/upload-rust-binary-action
## License
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or
[MIT license](LICENSE-MIT) at your option.
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.