push.yml

name: Pipeline
# consistency regarding formatting and idiomatic Rust

on:
  push:
    branches-ignore:
      - main
      - dev

env:
  CARGO_TERM_COLOR: always
  RUSTDOCFLAGS: "-Dwarnings"

jobs:
  pipeline:
    name: Pipeline - test and lints
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/checkout@v3

      - name: Setup dtolnay/rust-toolchain 
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable
          components: clippy, rustfmt

      # load project cache to reduce compilation time
      - name: Setup project cache
        uses: actions/cache@v3
        continue-on-error: false
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.toml') }}
          restore-keys: ${{ runner.os }}-cargo-

      - name: Update dependencies
        run: cargo update
      - name: Build
        run: cargo build
      - name: Generate docs
        run: cargo doc
      
      - name: Test
        run: cargo test --verbose

      # Lints: Clippy and Fmt
      - name: Clippy
        run: cargo clippy -- -D warnings
      - name: Format
        run:  cargo fmt --all -- --check