Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actions-rs/cargo
📦 GitHub Action for Rust `cargo` command
https://github.com/actions-rs/cargo
cargo cross github github-actions rust rust-lang
Last synced: about 1 month ago
JSON representation
📦 GitHub Action for Rust `cargo` command
- Host: GitHub
- URL: https://github.com/actions-rs/cargo
- Owner: actions-rs
- License: mit
- Archived: true
- Created: 2019-09-12T20:48:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T14:36:11.000Z (5 months ago)
- Last Synced: 2024-09-26T19:56:49.468Z (about 2 months ago)
- Topics: cargo, cross, github, github-actions, rust, rust-lang
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/rust-cargo
- Size: 1.1 MB
- Stars: 642
- Watchers: 6
- Forks: 58
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Rust `cargo` Action
[](https://actions-rs.github.io/#sponsoring)
[](https://gitter.im/actions-rs/community)
This GitHub Action runs specified [`cargo`](https://github.com/rust-lang/cargo)
command on a Rust language project.
**Table of Contents**
* [Example workflow](#example-workflow)
* [Use cases](#use-cases)
* [Inputs](#inputs)
* [Toolchain](#toolchain)
* [Cross-compilation](#cross-compilation)
* [License](#license)
* [Contribute and support](#contribute-and-support)
## Example workflow
```yaml
on: [push]
name: CI
jobs:
build_and_test:
name: Rust project
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
- uses: actions-rs/cargo@v1
with:
command: build
args: --release --all-features
```
See [additional recipes here](https://github.com/actions-rs/meta).
## Use cases
Note that this Action is not required usually
and you can just use [`run`](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)
step instead as in example below:
```yaml
jobs:
build_and_test:
name: Rust project
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
- run: cargo build --release --all-features
```
Why would you want to use this Action instead:
1. Transparent `cross` installation and execution with `use-cross: true` input enabled
2. Warnings and errors issued by `cargo` will be displayed in GitHub UI
## Inputs
| Name | Required | Description | Type | Default |
| ------------| :------: | -------------------------------------------------------------------------| ------ | --------|
| `command` | ✓ | Cargo command to run, ex. `check` or `build` | string | |
| `toolchain` | | Rust toolchain name to use | string | |
| `args` | | Arguments for the cargo command | string | |
| `use-cross` | | Use [`cross`](https://github.com/rust-embedded/cross) instead of `cargo` | bool | false |
## Toolchain
By default this Action will call whatever `cargo` binary is available
in the current [virtual environment](https://help.github.com/en/articles/software-in-virtual-environments-for-github-actions).
You can use [`actions-rs/toolchain`](https://github.com/actions-rs/toolchain)
to install specific Rust toolchain with `cargo` included.
## Cross-compilation
In order to make cross-compile an easy process,
this Action can install [cross](https://github.com/rust-embedded/cross)
tool on demand if `use-cross` input is enabled; `cross` executable will be invoked
then instead of `cargo` automatically.
All consequent calls of this Action in the same job
with `use-cross: true` input enabled will use the same `cross` installed.
```yaml
on: [push]
name: ARMv7 build
jobs:
linux_arm7:
name: Linux ARMv7
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
toolchain: stable
target: armv7-unknown-linux-gnueabihf
override: true
- uses: actions-rs/cargo@v1
with:
use-cross: true
command: build
args: --target armv7-unknown-linux-gnueabihf
```
## License
This Action is distributed under the terms of the MIT license, see [LICENSE](https://github.com/actions-rs/toolchain/blob/master/LICENSE) for details.
## Contribute and support
Any contributions are welcomed!
If you want to report a bug or have a feature request,
check the [Contributing guide](https://github.com/actions-rs/.github/blob/master/CONTRIBUTING.md).
You can also support author by funding the ongoing project work,
see [Sponsoring](https://actions-rs.github.io/#sponsoring).