docs.yml

# Builds the docs on every push and PR, deploys to GitHub Pages on main.
# `deploydocs(push_preview = true)` in docs/make.jl makes PR builds land on a
# preview URL instead of the live site, so a PR can be reviewed with its docs
# rendered before it merges. No Node is involved: the build is pure Julia
# (Documenter + the DocumenterLandingPage and DocumenterCodeBlocks plugins).
#
# Deliberately NOT triggered on tag pushes: TagBot tags each registered
# subpackage at the commit the General registry references, which need not sit
# on main (the ReactantServerExport-v1.0.0 tag landed on an orphaned feature
# branch commit whose tree could not resolve the docs environment). The live
# site tracks main, so a tag build would only rebuild the same site from a
# possibly stale tree.
name: Docs

on:
  push:
    branches: [main]
  pull_request:

jobs:
  docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1.12'
      - uses: julia-actions/cache@v2
      - name: Install Julia dependencies
        # docs/Manifest.toml is gitignored, so the docs environment is resolved
        # fresh here (ReactantServer and friends come from the [sources] paths,
        # and DocumenterLandingPage from its git URL, see CONTRIBUTING.md).
        run: julia --project=docs -e 'using Pkg; Pkg.instantiate()'
      - name: Build and deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: julia --project=docs docs/make.jl