github-page.yml

name: Haddocks

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  haddocks:
    name: Haddocks

    runs-on: ${{ matrix.os }}

    defaults:
      run:
        shell: bash

    strategy:
      fail-fast: false
      matrix:
        ghc: ["9.10"]
        os: [ubuntu-latest]

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
    - name: Install pandoc
      run: sudo apt install pandoc

    - name: Checkout io-sim repository
      uses: actions/checkout@v4

    - name: Install Haskell
      uses: haskell-actions/setup@v2
      id: setup-haskell
      with:
        ghc-version: ${{ matrix.ghc }}
        # we need unpublished `cabal` version to support sublibraries
        cabal-version: 'head'

    - uses: actions/cache@v4
      name: Cache cabal store
      with:
        path: ${{ steps.setup-haskell.outputs.cabal-store }}
        key: cache-haddock-${{ runner.os }}-${{ matrix.ghc }}-v1-${{ hashFiles('cabal-cache.cabal') }}-${{ github.sha }}
        restore-keys: cache-haddock-${{ runner.os }}-${{ matrix.ghc }}-v1-${{ hashFiles('cabal-cache.cabal') }}-

    - name: Update Hackage index
      run: cabal update

    - name: Run pandoc
      run: pandoc --from=gfm --to=haddock --output=README.haddock io-classes/README.md io-sim/README.md

    - name: Build haddocks 🔧
      run: |
        cabal haddock-project --prologue=README.haddock --hackage all

    - name: Upload artifacts
      uses: actions/upload-pages-artifact@v3
      with:
        path: ./haddocks

    - name: Deploy 🚀
      id: deployment
      uses: actions/deploy-pages@v4