#cargo-check #github-actions #json-error #format-json

app cargo-action-fmt

Converts cargo check (and clippy) JSON output to the GitHub Action error format

9 releases (5 stable)

1.0.4 Dec 4, 2022
1.0.2 Jul 18, 2022
1.0.1 May 17, 2022
0.1.3 Feb 14, 2022

#5 in #json-error

MIT license

8KB
84 lines

cargo-action-fmt

Takes JSON-formatted cargo check (and cargo clippy) output and formats it for GitHub actions.

Examples

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

GitHub Action

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

Example annotation

Dependencies

~1.7–2.8MB
~53K SLoC