Switch scheduled Pages deployment from concurrent git pushes to single artifact-based deploy (#16)

* Initial plan

* Switch scheduled workflow to artifact-based GitHub Pages deployment

Replace concurrent gh-pages git pushes with the recommended Actions
Pages pattern: build jobs run in parallel and upload artifacts, a
single deploy job downloads all artifacts and publishes once via
actions/configure-pages + actions/upload-pages-artifact +
actions/deploy-pages.

- schedule.yaml: set permissions (pages:write, id-token:write,
  contents:read), add concurrency group, pass publish:false to build
  jobs, add single deploy job
- build.yaml: update permissions, replace git-push publish job with
  deploy-pages-based publish (for standalone workflow_dispatch use)

Agent-Logs-Url: https://github.com/m-aciek/python-docs-offline/sessions/ef8d01ff-dbf0-4912-b4ea-425561a6b349

Co-authored-by: m-aciek <9288014+m-aciek@users.noreply.github.com>

* Skip deploy job on push trigger

Agent-Logs-Url: https://github.com/m-aciek/python-docs-offline/sessions/3a039646-7f76-4cf9-b6b4-cb675827b67a

Co-authored-by: m-aciek <9288014+m-aciek@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: m-aciek <9288014+m-aciek@users.noreply.github.com>

Author: Copilot

.github/workflows/build.yaml

@@ -45,7 +45,9 @@ on:
         default: '3'
         type: string
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
 jobs:
   build-html:
     runs-on: ubuntu-latest
@@ -184,56 +186,46 @@ jobs:
     needs: [build-html, build-text, build-texinfo, build-epub, build-pdf]
     if: ${{ !cancelled() && inputs.publish == 'true' }}
     runs-on: ubuntu-latest
-    concurrency:
-      group: gh-pages-publish
-      cancel-in-progress: false
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
-      - name: Checkout gh-pages branch
+      - name: Configure Pages
+        uses: actions/configure-pages@v5
+
+      - name: Checkout existing gh-pages content
+        id: checkout-pages
         uses: actions/checkout@v5
         with:
           ref: gh-pages
-          path: gh-pages
-      - name: Pull latest gh-pages
-        run: git -C gh-pages pull --rebase origin gh-pages
+          path: _site
+        continue-on-error: true
+
+      - name: Prepare site directory
+        run: |
+          mkdir -p _site/3
+          # Remove git metadata; safe even if checkout above did not succeed
+          rm -rf _site/.git
+
       - name: Download all artifacts
-        uses: actions/download-artifact@master
+        # Collect all build artifacts then merge into the publish directory
+        uses: actions/download-artifact@v4
         with:
-          path: artifacts
-      - name: Copy generated archives to gh-pages
-        run: |
-          mkdir -p gh-pages/3
-          # PDF
-          cp artifacts/python-${{ inputs.dist_version }}-docs-pdf-a4.zip/* gh-pages/3/ 2>/dev/null || true
-          cp artifacts/python-${{ inputs.dist_version }}-docs-pdf-a4.tar.bz2/* gh-pages/3/ 2>/dev/null || true
-          # HTML
-          cp artifacts/python-${{ inputs.dist_version }}-docs-html.zip/* gh-pages/3/ 2>/dev/null || true
-          cp artifacts/python-${{ inputs.dist_version }}-docs-html.tar.bz2/* gh-pages/3/ 2>/dev/null || true
-          # Text
-          cp artifacts/python-${{ inputs.dist_version }}-docs-text.zip/* gh-pages/3/ 2>/dev/null || true
-          cp artifacts/python-${{ inputs.dist_version }}-docs-text.tar.bz2/* gh-pages/3/ 2>/dev/null || true
-          # Texinfo
-          cp artifacts/python-${{ inputs.dist_version }}-docs-texinfo.zip/* gh-pages/3/ 2>/dev/null || true
-          cp artifacts/python-${{ inputs.dist_version }}-docs-texinfo.tar.bz2/* gh-pages/3/ 2>/dev/null || true
-          # EPUB
-          cp artifacts/python-${{ inputs.dist_version }}-docs.epub/* gh-pages/3/ 2>/dev/null || true
-      - name: Commit generated archives
-        id: commit
+          path: artifacts/
+
+      - name: Copy new archives into site directory
         run: |
-          cd gh-pages
-          git config user.name github-actions
-          git config user.email github-actions@github.com
-          git add 3/
-          if git diff --cached --quiet; then
-            echo "No documentation archives to commit"
-            echo "has_changes=false" >> "$GITHUB_OUTPUT"
-          else
-            git commit -m "Update documentation archives for ${{ inputs.dist_version }}"
-            echo "has_changes=true" >> "$GITHUB_OUTPUT"
-          fi
-      - name: Push commit
-        if: steps.commit.outputs.has_changes == 'true'
-        uses: ad-m/github-push-action@master
-        with:
-          branch: gh-pages
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          directory: gh-pages
+          # Copy generated archives (zip, tar.bz2, epub) into _site/3/,
+          # excluding PDF build logs which are for debugging only.
+          find artifacts/ -type f \( -name "*.zip" -o -name "*.tar.bz2" -o -name "*.epub" \) \
+            ! -name "python-*-pdf-logs.zip" \
+            -exec cp {} _site/3/ \;
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/schedule.yaml

@@ -4,8 +4,19 @@ on:
     - cron: '0 5 * * *'
   workflow_dispatch:
   push:
+
+# Pages deployment requires pages:write and id-token:write.
+# contents:write is no longer needed since we no longer push to gh-pages directly.
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+# Prevent overlapping scheduled runs from deploying to GitHub Pages simultaneously.
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: false
+
 jobs:
   get-versions:
     runs-on: ubuntu-latest
@@ -24,9 +35,63 @@ jobs:
       fail-fast: false
       matrix:
         include: ${{ fromJson(needs.get-versions.outputs.versions) }}
+    # Build jobs run concurrently and upload artifacts per version. The single
+    # deploy job below collects all artifacts and publishes once, avoiding
+    # concurrent git pushes/commit conflicts to gh-pages.
     uses: ./.github/workflows/build.yaml
     with:
       reference: ${{ matrix.branch }}
       dist_version: ${{ matrix.version }}
       python_version: ${{ matrix.python_version }}
-      publish: ${{ 'true' }}
+      publish: ${{ 'false' }}
+
+  deploy:
+    # A single deploy job runs after all build matrix jobs complete.
+    # Artifacts from every concurrent build job are merged here and published
+    # once via actions/deploy-pages, eliminating concurrent gh-pages push conflicts.
+    needs: build
+    if: ${{ !cancelled() && needs.build.result != 'failure' && github.event_name != 'push' }}
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Configure Pages
+        uses: actions/configure-pages@v5
+
+      - name: Checkout existing gh-pages content
+        id: checkout-pages
+        uses: actions/checkout@v5
+        with:
+          ref: gh-pages
+          path: _site
+        continue-on-error: true
+
+      - name: Prepare site directory
+        run: |
+          mkdir -p _site/3
+          # Remove git metadata; safe even if checkout above did not succeed
+          rm -rf _site/.git
+
+      - name: Download all build artifacts
+        # Collect artifacts uploaded by all concurrent build matrix jobs
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts/
+
+      - name: Copy new archives into site directory
+        run: |
+          # Copy generated archives (zip, tar.bz2, epub) into _site/3/,
+          # excluding PDF build logs which are for debugging only.
+          find artifacts/ -type f \( -name "*.zip" -o -name "*.tar.bz2" -o -name "*.epub" \) \
+            ! -name "python-*-pdf-logs.zip" \
+            -exec cp {} _site/3/ \;
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4