Skip to content

Deploy docs to GitHub Pages - main by caciolai #35

Deploy docs to GitHub Pages - main by caciolai

Deploy docs to GitHub Pages - main by caciolai #35

Workflow file for this run

name: Deploy Documentation
run-name: Deploy docs to GitHub Pages - ${{ github.ref_name }} by ${{ github.actor }}
on:
# Runs on pushes targeting the main branch with changes to docs, are/simulation, or workflow
push:
branches: ["main"]
paths:
- 'docs/**'
- 'are/simulation/**'
- '.github/workflows/deploy-site.yaml'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# 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:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Setup uv
id: setup-uv
uses: astral-sh/setup-uv@v5
with:
python-version: "3.12"
enable-cache: true
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Install dependencies and build docs
run: |
cd docs
make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4