ci.yml

name: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    name: Elixir ${{ matrix.elixir }}
    runs-on: ubuntu-latest
    container:
      image: elixir:${{ matrix.elixir }}
    strategy:
      fail-fast: false
      matrix:
        elixir:
        - '1.17'
        - '1.16'
        - '1.15'
        - '1.14'
        - '1.13'
        - '1.12'
        - '1.11'
        - '1.10'
        - '1.9'
        - '1.8'
        - '1.7'

    steps:
      - uses: actions/checkout@v3

      - name: Setup Environment
        run: |
          epmd -daemon
          mix local.hex --force
          mix local.rebar --force
          mix deps.get

      - name: Run Tests
        run: mix test --trace

  bench:
    if: github.ref == 'refs/heads/main'
    name: Benchmark
    runs-on: ubuntu-latest
    container:
      image: elixir:1.17
    steps:
      - uses: actions/checkout@v3

      - name: Setup Environment
        run: |
          epmd -daemon
          mix local.hex --force
          mix local.rebar --force
          mix deps.get

      - name: Run Benchmarks
        run: mix bench

  coverage:
    name: Coverage
    runs-on: ubuntu-latest
    container:
      image: elixir:1.17
    env:
      MIX_ENV: cover
    steps:
      - uses: actions/checkout@v3

      - name: Setup Environment
        run: |
          epmd -daemon
          mix local.hex --force
          mix local.rebar --force
          mix deps.get

      - name: Generate Coverage
        run: mix coveralls.github
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  docs:
    name: Documentation
    runs-on: ubuntu-latest
    container:
      image: elixir:1.17
    steps:
      - uses: actions/checkout@v3

      - name: Setup Environment
        run: |
          epmd -daemon
          mix local.hex --force
          mix local.rebar --force
          mix deps.get

      - name: Build Documentation
        run: |
          mix docs 2>&1 | tee output.txt
          ! grep warning output.txt

          mv docs/overview.md docs/overview.md.1
          mix run scripts/overview.exs
          diff docs/overview.md docs/overview.md.1 > /dev/null 2>&1

  lint:
    name: Linting
    runs-on: ubuntu-latest
    container:
      image: elixir:1.17
    steps:
      - uses: actions/checkout@v3

      - name: Setup Environment
        run: |
          epmd -daemon
          mix local.hex --force
          mix local.rebar --force
          mix deps.get

      - name: Validate Formatting
        run: mix format --check-formatted

      - name: Validate Linting
        run: mix credo --all --format=oneline