Documenter.yaml

name: Documentation

on:
  pull_request:
    paths:
      - '.github/workflows/Documenter.yml'
      - 'docs/**'
      - 'lib/**'
      - 'src/**'
  push:
    branches:
      - main
    tags: '*'
    paths:
      - '.github/workflows/Documenter.yml'
      - 'docs/**'
      - 'lib/**'
      - 'src/**'

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

jobs:
  docs:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1'
      - uses: julia-actions/cache@v2
      - name: Instantiate docs environment
        run: |
          julia --color=yes --project=docs -e '
            using Pkg
            Pkg.instantiate()'
        env:
          JULIA_PKG_SERVER_REGISTRY_PREFERENCE: eager
      - name: Run doctests
        run: |
          julia --color=yes --project=docs -e '
            using Documenter: DocMeta, doctest
            using Reactant
            DocMeta.setdocmeta!(Reactant, :DocTestSetup, :(using Reactant); recursive=true)
            doctest(Reactant)'
      - name: Build documentation
        run: julia --color=yes --project=docs docs/make.jl
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}