rust-rustfmt-check
ActionsTags
(1)GitHub Action to format Rust code using rustfmt.
This action can be used to keep Rust code formatted correctly.
This action supports three different modes. The commit mode is the default
mode.
A commit is pushed when formatting is required.
on: push
name: Rustfmt
jobs:
format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt
- uses: mbrobbel/rustfmt-check@master
with:
token: ${{ secrets.GITHUB_TOKEN }}
The action reviews the PR, either requesting formatting changes, or approving if no formatting is required.
on: pull_request
name: Rustfmt
jobs:
format:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@nightly
with:
components: rustfmt
- uses: mbrobbel/rustfmt-check@master
with:
token: ${{ secrets.GITHUB_TOKEN }}
mode: review
Please note that this mode requires:
- A nightly Rust toolchain
- Allowing GitHub Actions to create or approve pull reqeuests.
The action creates a pull request with the formatting changes.
on: pull_request
name: Rustfmt
jobs:
format:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt
- uses: mbrobbel/rustfmt-check@master
with:
token: ${{ secrets.GITHUB_TOKEN }}
mode: pull
Please note that this mode requires:
See action.yml.
rust-rustfmt-check 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.
Tags
(1)rust-rustfmt-check 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.