ci.yml

name: CI

on: [push, pull_request]

jobs:

  # Ensure code is properly formatted
  format:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - run: rustup toolchain install stable --no-self-update --profile minimal --component rustfmt
    - name: Check library formatting
      run: cargo fmt --check --all
  
  # Lint the library
  clippy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - run: rustup toolchain install stable --no-self-update --profile minimal --component clippy
    - name: Lint the library
      run: cargo clippy -- -D warnings

  # Run tests
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - run: rustup toolchain install stable --no-self-update --profile minimal
    - name: Run unit and documentation tests
      run: cargo test

  # Make sure documentation builds, and doclinks are valid
  doc:
    env:
      RUSTDOCFLAGS: -D warnings
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - run: rustup toolchain install stable --no-self-update --profile minimal
    - name: Check documentation and doclinks
      run: cargo rustdoc