docs.yaml

name: Docs

"on":
  merge_group: {}
  pull_request: {}
  push:
    branches-ignore:
      # These should always correspond to pull requests, so ignore them for
      # the push trigger and let them be triggered by the pull_request
      # trigger, avoiding running the workflow twice.  This is a minor
      # optimization so there's no need to ensure this is comprehensive.
      - "dependabot/**"
      - "gh-readonly-queue/**"
      - "renovate/**"
      - "tickets/**"
      - "u/**"
  workflow_dispatch: {}

jobs:
  docs:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Print GitHub event name
        run: echo "${{ github.event_name }}"

      - name: Filter paths
        uses: dorny/paths-filter@v3
        id: filter
        with:
          filters: |
            docs:
              - ".github/workflows/docs.yaml"
              - "docs/**"
              - "applications/*/Chart.yaml"
              - "applications/*/values.yaml"
              - "applications/argocd/values-*.yaml"
              - "applications/gafaelfawr/values-*.yaml"
              - "environments/values-*.yaml"
              - "requirements/*.txt"
              - "src/phalanx/**"
            docsSpecific:
              - "docs/**"

      - name: Install graphviz
        if: steps.filter.outputs.docs == 'true' || github.event_name == 'workflow_dispatch'
        run: sudo apt-get install graphviz

      - name: Build docs
        if: steps.filter.outputs.docs == 'true' || github.event_name == 'workflow_dispatch'
        uses: lsst-sqre/run-tox@v1
        with:
          python-version: "3.12"
          tox-envs: docs
          tox-requirements: requirements/tox.txt
          cache-key-prefix: docs

      # Upload docs:
      # - on pushes to main if *any* documentation content might have changed
      # - on workflow dispatches if any documentation content might have changed
      # - on pushes to tickets/ branches if docs/ directory content changed
      - name: Upload to LSST the Docs
        uses: lsst-sqre/ltd-upload@v1
        with:
          project: "phalanx"
          dir: "docs/_build/html"
          username: ${{ secrets.LTD_USERNAME }}
          password: ${{ secrets.LTD_PASSWORD }}
        if: >-
          (github.event_name == 'push' && github.ref_name == 'main' && steps.filter.outputs.docs == 'true')
          || (github.event_name == 'workflow_dispatch')
          || (github.event_name == 'pull_request' && startsWith(github.head_ref, 'tickets/') && steps.filter.outputs.docsSpecific == 'true')