rs-cargo Action

This GitHub Action runs specified cargo command on a Rust language project.

This GitHub Action has been forked from actions-rs/cargo. The original project published under the name rust-cargo. See LICENSE for copyright attribution details.

Table of Contents

• Example workflow
• Use cases
• Inputs
• Toolchain
• Cross-compilation
• Release immutability
• License

Example workflow

on: [push]

name: CI

jobs:
  build_and_test:
    name: Rust project
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: actions-rust-lang/setup-rust-toolchain@ecabd13d1c56bd1345c230e542e9144811ad706f # v2.0.0
      - uses: clechasseur/[email protected]
        with:
          command: build
          args: --release --all-features

Use cases

Note that this Action is not usually required and you can just use a run step instead:

jobs:
  build_and_test:
    name: Rust project
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: actions-rust-lang/setup-rust-toolchain@ecabd13d1c56bd1345c230e542e9144811ad706f # v2.0.0
      - run: cargo build --release --all-features

Why would you want to use this Action instead?

1. Transparent cargo-like tool installation (like cross or cargo-hack)
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
working-directory		Directory where to perform cargo command	string
tool		Tool to use instead of cargo (ex: cross, cargo-hack)	string
cache-key		Cache key when using a non-cargo tool	string	rs-cargo

Toolchain

By default this Action will call whatever cargo binary is available in the current virtual environment.

You can use actions-rust-lang/setup-rust-toolchain to install a specific Rust toolchain with cargo included.

Cross-compilation

In order to make cross-compilation an easy process, this action can install cross on demand by setting tool input to cross; the cross executable will be invoked then instead of cargo automatically.

All consequent calls of this action in the same job with tool: cross will use the same cross binary.

on: [push]

name: ARMv7 build

jobs:
  linux_arm7:
    name: Linux ARMv7
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: actions-rust-lang/setup-rust-toolchain@ecabd13d1c56bd1345c230e542e9144811ad706f # v2.0.0
        with:
          targets: armv7-unknown-linux-gnueabihf
      - uses: clechasseur/[email protected]
        with:
          command: build
          args: --target armv7-unknown-linux-gnueabihf
          tool: cross

Release immutability

Starting with release 5.0.0, this GitHub action's releases will be marked as immutable. This means that once a release is created, its tag cannot be modified in any way.

Previously, best practices for using GitHub actions in workflows were to pin the actions to a specific Git commit hash. With immutable releases, this is no longer necessary and the actual Git tag is safe to use. Because of this, starting with release 5.0.0, this GitHub action will no longer provide a floating major version tag (like v5, for example). To use a specific version of this action, pin it to the release tag (like v5.0.0).

License

MIT license

Contributing

See CONTRIBUTING.

Development

See DEVELOPMENT.