Documentation.yml

name: Documentation
on:
  push:
    branches: [main]
    tags: '*'
  pull_request:
    branches: [main]
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:
  build:
    # These permissions are needed to:
    # - Deploy the documentation: https://documenter.juliadocs.org/stable/man/hosting/#Permissions
    # - Delete old caches: https://github.com/julia-actions/cache#usage
  permissions:
    actions: write
    contents: write
    pull-requests: read
    statuses: write
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v5
    - uses: julia-actions/setup-julia@v2
      with:
        version: "1"
    - uses: julia-actions/cache@v2
    - uses: julia-actions/julia-docdeploy@v1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}