galaxy/.github/workflows/docs.yaml

name: Build docs
on:
  push:
    paths-ignore:
      - 'client/**'
      - 'lib/galaxy_test/selenium/**'
      - 'packages/**'
  pull_request:
    paths-ignore:
      - 'client/**'
      - 'lib/galaxy_test/selenium/**'
      - 'packages/**'
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
permissions: {}
jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.10']
    steps:
      - name: Get target branch name (push)
        if: github.event_name == 'push'
        run: echo "TARGET_BRANCH=${GITHUB_REF##*/}" >> $GITHUB_ENV
      - name: Get target branch name (pull request)
        if: github.event_name == 'pull_request'
        run: echo "TARGET_BRANCH=$GITHUB_BASE_REF" >> $GITHUB_ENV
      - name: Show target branch name
        run: echo $TARGET_BRANCH
      - uses: actions/checkout@v7.0.1
        with:
          fetch-depth: 0
          persist-credentials: false
      - name: Install uv
        uses: astral-sh/setup-uv@v9.0.0
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install Python dependencies
        run: |
          uv venv .venv
          . .venv/bin/activate
          uv pip install -r requirements.txt -r lib/galaxy/dependencies/dev-requirements.txt sphinxcontrib-simpleversioning
      - name: Add Google Analytics to doc/source/conf.py
        run: |
          sed -i -e "/html_theme_options = {/a\
          \    'analytics_id': 'UA-45719423-17'," -e "s#https://docs.galaxyproject.org/en/[^/]*/#https://docs.galaxyproject.org/en/$TARGET_BRANCH/#" doc/source/conf.py
      - name: Checkout the latest doc/source/conf.versioning.py
        if: github.event_name != 'push' || github.ref != 'refs/heads/dev'
        run: |
          # We cannot just download the latest version from dev, because it may be newer in this branch/PR
          git fetch origin dev:dev
          if [ ! -f doc/source/conf.versioning.py ] || [ "$(git log -1 --pretty="format:%ct" dev -- doc/source/conf.versioning.py)" -gt "$(git log -1 --pretty="format:%ct" -- doc/source/conf.versioning.py)" ]; then
              git checkout dev -- doc/source/conf.versioning.py
          fi
      - name: Append doc/source/conf.versioning.py
        run: cat doc/source/conf.versioning.py >> doc/source/conf.py
      - name: Build docs
        env:
          # sphinx.ext.viewcode is not parallelized and dominates the build.
          # Pull request builds only need to prove the documentation still
          # builds, so skip it there and keep it for the deployed builds.
          GALAXY_DOCS_SKIP_VIEW_CODE: ${{ github.event_name == 'pull_request' && '1' || '0' }}
        run: make docs
      - name: Deploy docs
        if: github.event_name == 'push' && github.repository_owner == 'galaxyproject'
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        run: |
          case "$TARGET_BRANCH" in
              release_[[:digit:]][[:digit:]].[[:digit:]][[:digit:]] | release_[[:digit:]][[:digit:]].[[:digit:]] | master)
                  UPLOAD_DIR=$TARGET_BRANCH
                  ;;
              dev)
                  UPLOAD_DIR=latest
                  ;;
              *)
                  echo "Not deploying documentation for branch $TARGET_BRANCH"
                  exit 0
                  ;;
          esac
          uv tool install awscli
          aws s3 sync doc/build/html/ "s3://galaxy-docs/en/$UPLOAD_DIR" --region us-east-2 --size-only --delete