Takes JSON-formatted cargo check
(and cargo clippy
) output and formats it
for GitHub actions.
This tool can be used with a variety of cargo
commands:
:; cargo check -q --message-format=json | cargo-action-fmt
:; cargo clippy -q --message-format=json | cargo-action-fmt
:; cargo doc --message-format=json | cargo-action-fmt
Note that this tool does not currently support cargo fmt
or cargo test
output. However, you can invoke cargo test
so that test compilation errors are
annotated properly:
:; cargo test --no-run --message-format=json | cargo-action-fmt
It's primarily intended to be used in a GitHub Actions workflow:
docs:
runs-on: ubuntu-latest
container: rust:slim
steps:
- uses: olix0r/cargo-action-fmt/setup@v2
- uses: actions/checkout@v2
- run: cargo doc --no-deps --message-format=json | cargo-action-fmt