docs.yaml

name: Documentation

on:
  workflow_dispatch:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
  documentation:
    runs-on: ubuntu-latest
    timeout-minutes: 15

    concurrency:
      group: ci-docs-${{ github.event_name }}-${{ github.ref }}
      cancel-in-progress: true

    defaults:
      run:
        shell: bash -l {0}

    steps:
      - uses: actions/checkout@v4

      - uses: conda-incubator/setup-miniconda@v3
        with:
          miniforge-version: latest
          environment-file: conda/dev.yaml
          channels: conda-forge,nodefaults
          activate-environment: astx
          auto-update-conda: true
          conda-solver: libmamba
          python-version: "3.9.*"

      - name: Install deps
        run: |
          poetry config virtualenvs.create false
          poetry install

      - name: Test tutorials
        run: makim --verbose tests.notebooks

      - name: Generate documentation with changes from semantic-release
        run: makim --verbose docs.build

      - name: GitHub Pages action
        uses: peaceiris/actions-gh-pages@v3.5.9
        if: ${{ github.event_name == 'workflow_dispatch' }}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./build/