Skip to content

Migrate workflows to composite actions #5

Migrate workflows to composite actions

Migrate workflows to composite actions #5

Workflow file for this run

name: Build HTML [using jupyter-book]
on: [pull_request]
jobs:
preview:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
# NEW: Use composite action for environment setup
- name: Setup Lecture Environment
uses: quantecon/actions/setup-lecture-env@main
with:
python-version: '3.13'
environment-file: 'environment.yml'
- name: Graphics Support #TODO: Review if graphviz is needed
run: |
sudo apt-get -qq update && sudo apt-get install -y graphviz
# NEW: Use composite action for LaTeX setup
- name: Install LaTeX Dependencies
uses: quantecon/actions/setup-latex@main
- name: Display Conda Environment Versions
shell: bash -l {0}
run: conda list
- name: Display Pip Versions
shell: bash -l {0}
run: pip list
- name: Download "build" folder (cache)
uses: dawidd6/action-download-artifact@v11
with:
workflow: cache.yml
branch: main
name: build-cache
path: _build
# Build Assets (Download Notebooks and PDF via LaTeX)
# NEW: Use composite action for PDF build
- name: Build PDF from LaTeX
id: build-pdf
uses: quantecon/actions/build-lectures@main
with:
builder: 'pdflatex'
source-dir: 'lectures'
extra-args: '-n --keep-going'
- 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: Upload Execution Reports (LaTeX)
uses: actions/upload-artifact@v5
if: failure()
with:
name: execution-reports-latex
path: _build/latex/reports
# NEW: Use composite action for Jupyter build
- name: Build Download Notebooks (sphinx-tojupyter)
id: build-jupyter
uses: quantecon/actions/build-lectures@main
with:
builder: 'jupyter'
source-dir: 'lectures'
extra-args: ''
- 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
# Build HTML (Website)
# BUG: rm .doctress to remove `sphinx` rendering issues for ipywidget mimetypes
# and clear the sphinx cache for building final HTML documents.
- name: Remove doctrees cache
run: rm -r _build/.doctrees
# NEW: Use composite action for HTML build
- name: Build HTML
id: build-html
uses: quantecon/actions/build-lectures@main
with:
builder: 'html'
source-dir: 'lectures'
extra-args: '-nW --keep-going'
- name: Upload Execution Reports (HTML)
uses: actions/upload-artifact@v5
if: failure()
with:
name: execution-reports-html
path: _build/html/reports
# NEW: Use composite action for Netlify deployment
- name: Preview Deploy to Netlify
uses: quantecon/actions/deploy-netlify@main
with:
netlify-auth-token: ${{ secrets.NETLIFY_AUTH_TOKEN }}
netlify-site-id: ${{ secrets.NETLIFY_SITE_ID }}
build-dir: ${{ steps.build-html.outputs.build-path }}
production: 'false'
github-token: ${{ secrets.GITHUB_TOKEN }}