docs_make.yml

name: Make Documentation

permissions:
  contents: write
  pull-requests: write

on:
  workflow_dispatch:
  schedule:
    - cron: '10 2 * * 3'
  # workflow_dispatch:
  # push:
  #   branches:
  #     - main

jobs:
  build_docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'

      - name: Install uv and dependencies
        run: |
          pip install uv
          uv venv
          uv pip install -e .[docs]

      - name: Install pre-commit
        run: uv pip install pre-commit

      - name: Install modules from packages.json via uv, skipping "colrev"
        run: |
          jq -r '.[] | select(.module != "colrev") | .module' colrev/packages/packages.json | while read module; do
            uv pip install $module
          done

      - name: Setup git
        run: |
          git config --global user.name 'github-actions'
          git config --global user.email 'github-actions@github.com'

      - name: Set branch name
        run: |
          echo "BRANCH_NAME=docs-update-$(date '+%Y-%m-%d_%H-%M-%S')" >> $GITHUB_ENV
          echo ${{ env.BRANCH_NAME }}

      - name: Switch to branch ${{ env.BRANCH_NAME }}
        run: |
          git checkout -b ${{ env.BRANCH_NAME }}

      - name: Clean old documentation build
        run: rm -rf docs/source/dev_docs/_autosummary/*

      - name: Run docs update
        run: uv run colrev env --update_package_list

      - name: Build documentation with Sphinx
        run: uv run sphinx-build -b html docs/source docs/build

      - name: Run pre-commit hooks excluding black
        continue-on-error: true
        run: uv run pre-commit run --all-files

      - name: Commit changes and create pull request
        continue-on-error: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          git add .
          if git diff --staged --quiet; then
            echo "No changes to commit"
          else
            git commit -m "Update documentation"
            git push --set-upstream origin ${{ env.BRANCH_NAME }}
            # Fetch the main branch and check for differences
            git fetch origin main:main
            if git diff ${{ env.BRANCH_NAME }} main --quiet; then
              echo "No effective changes to apply"
            else
              gh pr create --title "Update documentation" --body "This PR updates the documentation." --head ${{ env.BRANCH_NAME }} --base main
            fi
          fi