Check formatting of Rust code with rustfmt
ActionsRun cargo fmt --all and report all formatting differences in a nice overview.
It works best in combination with actions-rust-lang/setup-rust-toolchain for problem matcher highlighting.
Execution Summary:
Problem Matcher:
name: "Test Suite"
on:
push:
pull_request:
jobs:
formatting:
name: cargo fmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Ensure rustfmt is installed and setup problem matcher
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
components: rustfmt
- name: Rustfmt Check
uses: actions-rust-lang/rustfmt@v1All inputs are optional.
If a toolchain file (i.e., rust-toolchain or rust-toolchain.toml) is found in the root of the repository, it takes precedence.
All input values are ignored if a toolchain file exists.
| Name | Description | Default |
|---|---|---|
manifest-path |
Path to the Cargo.toml file, by default in the root of the repository. |
./Cargo.toml |
Check formatting of Rust code with rustfmt is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Check formatting of Rust code with rustfmt is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.