main.yml

name: Build Docs

on:
  # Trigger on pushes to the main branch only.
  # See #5 ref restricting to tags.
  push:
    branches: [ main ]

  # Or run manually.
  workflow_dispatch:

jobs:
  build-and-upload:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: '3.x'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install Django Sphinx myst-parser furo
          pip install -e .
      - name: Build docs
        run: make json
        working-directory: ./docs
      # Refs #22: Upload an artifact containing the built docs.
      - name: Upload docs
        id: artifact-upload-step
        uses: actions/upload-artifact@v2
        with:
          # Use a name from the commit hash to avoid collisions.
          name: docs-${{ github.sha }}
          path: docs/build/json
      - name: Get artifact details
        run:
          echo 'Artifact ID is ${{ steps.artifact-upload-step.outputs.artifact-id }}' >> $GITHUB_STEP_SUMMARY
          echo 'Artifact Name is ${{ steps.artifact-upload-step.outputs.artifact-name }}' >> $GITHUB_STEP_SUMMARY
          echo 'Artifact URL is ${{ steps.artifact-upload-step.outputs.artifact-url }}' >> $GITHUB_STEP_SUMMARY