CI Docs workflow (posit-dev/great-tables)

name: CI Docs
 
on:
  push:
    branches:
      - main
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build-docs:
    timeout-minutes: 30
    name: "Build Docs"
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: "3.13"
      - name: Install dependencies
        run: |
          python -m pip install --no-cache-dir "great-docs[svg] @ git+https://github.com/posit-dev/great-docs.git@main"
          python -m pip install polars pandas numpy pyarrow plotnine gt-extras pointblank ibis-framework[duckdb]
          python -m pip install ".[extra]"
      - name: Set up Quarto
        uses: quarto-dev/quarto-actions/setup@v2
      - name: Build docs
        run: |
          great-docs build
      - name: Save docs artifact
        uses: actions/upload-artifact@v4
        with:
          name: docs-html
          path: great-docs/_site
 
  publish-docs:
    timeout-minutes: 30
    name: "Publish Docs"
    runs-on: latchkey-small
    needs: "build-docs"
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: actions/download-artifact@v4
        with:
          name: docs-html
          path: great-docs/_site
      - uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: great-docs/_site
 
  preview-docs:
    timeout-minutes: 30
    name: "Preview Docs"
    runs-on: latchkey-small
    needs: "build-docs"
    if: github.event_name == 'pull_request'
    steps:
      - uses: actions/download-artifact@v4
        with:
          name: docs-html
          path: great-docs/_site
 
      - name: Configure pull release name
        if: ${{github.event_name == 'pull_request'}}
        run: |
          echo "RELEASE_NAME=pr-${PR_NUMBER}" >> $GITHUB_ENV
        env:
          PR_NUMBER: ${{ github.event.number }}
      - name: Configure branch release name
        if: ${{github.event_name != 'pull_request'}}
        run: |
          echo "RELEASE_NAME=${GITHUB_REF_NAME/\//-}" >> $GITHUB_ENV
 
      - name: Create Github Deployment
        uses: bobheadxi/deployments@v1
        id: deployment
        if: ${{ !github.event.pull_request.head.repo.fork }}
        with:
          step: start
          token: ${{ secrets.GITHUB_TOKEN }}
          env: ${{ env.RELEASE_NAME }}
          ref: ${{ github.head_ref }}
          transient: true
          logs: "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
 
      - name: Netlify docs preview
        if: ${{ !github.event.pull_request.head.repo.fork }}
        run: |
          npm install -g netlify-cli
          netlify link --name="gt-python"
          if [ "${ALIAS}" == "main" ]; then
            netlify deploy --dir=great-docs/_site --alias="main"
          else
            netlify deploy --dir=great-docs/_site --alias="${ALIAS}"
          fi
        env:
          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
          ALIAS: ${{ steps.deployment.outputs.env }}
 
      - name: Update Github Deployment
        uses: bobheadxi/deployments@v1
        if: ${{ !github.event.pull_request.head.repo.fork && always() }}
        with:
          step: finish
          token: ${{ secrets.GITHUB_TOKEN }}
          status: ${{ job.status }}
          env: ${{ steps.deployment.outputs.env }}
          env_url: "https://${{ steps.deployment.outputs.env }}--gt-python.netlify.app"
          deployment_id: ${{ steps.deployment.outputs.deployment_id }}