checks.yml

name: Quality Checks

on:
  push:
    branches: [master]
  pull_request:
  workflow_dispatch:

env:
  CARGO_REGISTRIES_CRATES_IO_PROTOCOL: git

jobs:
  # checks markdown links
  link-check:
    name: Links
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Check markdown links
        uses: gaurav-nelson/github-action-markdown-link-check@v1
        with:
          use-quiet-mode: "yes"
          config-file: ".github/workflows/mlc_config.json"

  # ensures proper formatting and clippy lint
  lint-check:
    name: Linting
    runs-on: ubuntu-latest
    steps:
      - name: Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.9.1
        with:
          access_token: ${{ github.token }}

      - uses: actions/checkout@v3
      - name: Install latest nightly
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: nightly
          components: rustfmt, clippy

      - name: Rust Cache
        uses: Swatinem/rust-cache@v1.3.0

      - name: Run Linters
        run: |
          sudo apt-get install protobuf-compiler &&
          cargo fmt --all -- --check &&
          cargo clippy -Zunstable-options -- -D warnings -D clippy::unwrap_used