docs.yml

name: Documentation

on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

concurrency:
  # Skip intermediate builds: always.
  # Cancel intermediate builds: only if it is a pull request build.
  group: ${{ github.workflow }}-${{ github.ref }}-html
  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
  HTML:
    runs-on: ubuntu-latest
    permissions:
      actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
      contents: write
      statuses: write
    steps:
      - uses: actions/checkout@v4
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1.10'
          show-versioninfo: true
      - uses: julia-actions/cache@v2
      - name: Install dependencies
        shell: julia --project=doc --color=yes {0}
        run: |
          using Pkg
          Pkg.develop(PackageSpec(path=pwd()))
          Pkg.instantiate()
      - name: Build and deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
        run: |
          julia --project=doc/ doc/make.jl deploy
      - name: Upload HTML
        uses: actions/upload-artifact@v4
        with:
          name: html-site
          path: doc/build/