publish.yml

name: Build & Publish to GH Pages
on:
  push:
    tags:
      - 'publish*'

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: write   # write: upload release assets (html archive, checksum, manifest)
  actions: read     # dawidd6/action-download-artifact reads the cache.yml build artifact
  pages: write
  id-token: write   # required for OIDC-based Pages deployment

# Allow only one concurrent deployment; don't cancel an in-flight deploy
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  publish:
    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
    runs-on: "runs-on=${{ github.run_id }}/family=g4dn.2xlarge/image=quantecon_ubuntu2404/volume=80gb/spot=false"
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs['page-url'] }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7
        with:
          fetch-depth: 0
      - name: Setup Anaconda
        uses: conda-incubator/setup-miniconda@v4
        with:
          auto-update-conda: true
          auto-activate-base: true
          miniconda-version: 'latest'
          python-version: "3.13"
          environment-file: environment.yml
          activate-environment: quantecon
      - name: Install JAX and Numpyro
        shell: bash -l {0}
        run: |
          pip install -U "jax[cuda13]"
          pip install numpyro
          python scripts/test-jax-install.py
      - name: Check nvidia drivers
        shell: bash -l {0}
        run: |
          nvidia-smi
      - name: Display Conda Environment Versions
        shell: bash -l {0}
        run: conda list
      - name: Display Pip Versions
        shell: bash -l {0}
        run: pip list
      # Download Build Cache from cache.yml
      - name: Download "build" folder (cache)
        uses: dawidd6/action-download-artifact@v21
        with:
          workflow: cache.yml
          branch: main
          name: build-cache
          path: _build
      # Build Assets (Download Notebooks, PDF via LaTeX)
      - name: Build PDF from LaTeX
        shell: bash -l {0}
        run: |
          jb build lectures --builder pdflatex --path-output ./ -n -W --keep-going
      - name: Upload Execution Reports (LaTeX)
        uses: actions/upload-artifact@v7
        if: failure()
        with:
          name: execution-reports-latex
          path: _build/latex/reports
      - name: Copy LaTeX PDF for GH-PAGES
        shell: bash -l {0}
        run: |
          mkdir -p _build/html/_pdf
          cp -u _build/latex/*.pdf _build/html/_pdf
      - name: Build Download Notebooks (sphinx-tojupyter)
        shell: bash -l {0}
        run: |
          jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter -n -W --keep-going
          zip -r download-notebooks.zip _build/jupyter
      - name: Upload Execution Reports (Download Notebooks)
        uses: actions/upload-artifact@v7
        if: failure()
        with:
          name: execution-reports-notebooks
          path: _build/jupyter/reports
      - uses: actions/upload-artifact@v7
        with:
          name: download-notebooks
          path: download-notebooks.zip
      - name: Copy Download Notebooks for GH-PAGES
        shell: bash -l {0}
        run: |
          mkdir -p _build/html/_notebooks
          cp -u _build/jupyter/*.ipynb _build/html/_notebooks
      # Final Build of HTML (with assets)
      - name: Build HTML
        shell: bash -l {0}
        run: |
          jb build lectures --path-output ./ -n -W --keep-going
      - name: Upload Execution Reports (HTML)
        uses: actions/upload-artifact@v7
        if: failure()
        with:
          name: execution-reports-html
          path: _build/html/reports
      - name: Deploy to GitHub Pages
        id: deployment
        uses: quantecon/actions/publish-gh-pages@v0
        with:
          build-dir: _build/html
          cname: python.quantecon.org
          create-release-assets: 'true'
          asset-name: 'lecture-python-html'
          github-token: ${{ secrets.GITHUB_TOKEN }}
      - name: Prepare lecture-python.notebooks sync
        shell: bash -l {0}
        run: |
          mkdir -p _build/lecture-python.notebooks
          cp -a _notebook_repo/. _build/lecture-python.notebooks
          cp _build/jupyter/*.ipynb _build/lecture-python.notebooks
          ls -a _build/lecture-python.notebooks
      - name: Commit notebooks to lecture-python.notebooks
        shell: bash -l {0}
        env:
          QE_SERVICES_PAT: ${{ secrets.QUANTECON_SERVICES_PAT }}
        run: |
          git clone https://quantecon-services:$QE_SERVICES_PAT@github.com/quantecon/lecture-python.notebooks

          cp _build/lecture-python.notebooks/*.ipynb lecture-python.notebooks

          cd lecture-python.notebooks
          git config user.name "QuantEcon Services"
          git config user.email "admin@quantecon.org"
          git add *.ipynb
          git commit -m "auto publishing updates to notebooks"
          git push origin main