build.yml

name: Build
on: [push]

jobs:
    rustfmt:
        runs-on: ubuntu-latest
        env:
            CARGO_TERM_COLOR: always
            NUM_JOBS: 2
        steps:
            - uses: actions/checkout@v3
            - uses: actions-rs/toolchain@v1
              with:
                  toolchain: stable
                  profile: minimal
                  override: true
                  components: rustfmt, clippy
            - uses: Swatinem/rust-cache@v2
            - uses: actions-rs/cargo@v1
              with:
                  command: fmt
                  args: --check

    # Run the build, clippy, and test commands in the same job in serial so they can share the same
    # build directory, and hopefully run faster.
    build-lint-test:
        runs-on: ubuntu-latest
        env:
            RUSTFLAGS: -Dwarnings
            CARGO_TERM_COLOR: always
            NUM_JOBS: 2
        steps:
            - uses: actions/checkout@v3
            - uses: actions-rs/toolchain@v1
              with:
                  toolchain: stable
                  profile: minimal
                  override: true
                  components: rustfmt, clippy
            - uses: Swatinem/rust-cache@v2
            - uses: taiki-e/install-action@v2
              with:
                  tool: cargo-tarpaulin

            - name: Build
              uses: actions-rs/cargo@v1
              with:
                  command: build
                  args: --release --all-targets --all-features

            - name: Lint
              uses: actions-rs/cargo@v1
              with:
                  command: clippy
                  args: --release --all-targets --all-features

            - name: Test
              uses: actions-rs/cargo@v1
              with:
                  command: tarpaulin
                  args: --release --all-features --out xml

            # TODO: Code coverage badge on README

            - name: Get Pull Request Number
              id: pr
              run: echo "pull_request_number=$(gh pr view --json number -q .number || echo "")" >> $GITHUB_OUTPUT
              env:
                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
            - run: echo "Found PR number '${{ steps.pr.outputs.pull_request_number }}' with the github CLI"

            - name: PR coverage report comment
              uses: 5monkeys/cobertura-action@v13
              if: github.ref != 'refs/heads/main'
              with:
                  path: 'cobertura.xml'
                  repo_token: ${{ secrets.GITHUB_TOKEN }}
                  pull_request_number: ${{ steps.pr.outputs.pull_request_number }}
                  only_changed_files: true
                  show_line: true
                  show_branch: true
                  skip_covered: false
                  # If we want to enforce a minimum coverage percentage, this is how.
                  minimum_coverage: 0
                  fail_below_threshold: false