Skip to content

MyST GitHub Pages Deploy #338

MyST GitHub Pages Deploy

MyST GitHub Pages Deploy #338

Workflow file for this run

# This file was created automatically with `myst init --gh-pages` 🪄 💚
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
name: MyST GitHub Pages Deploy
on:
workflow_run:
workflows:
- "Update Notebooks"
types:
- completed
push:
# Runs on pushes targeting the default branch
branches: [main]
env:
# `BASE_URL` determines the website is served from, including CSS & JS assets
# You may need to change this to `BASE_URL: ''`
BASE_URL: ""
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
# NOTE: If this was a successful update of the notebooks, or a push to main...
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'push' }}
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install uv
uses: astral-sh/setup-uv@v5
- name: Build HTML Assets
run: make build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "./_build/html"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4