Skip to content

Merge pull request #17 from jmchilton/updates_2025 #7

Merge pull request #17 from jmchilton/updates_2025

Merge pull request #17 from jmchilton/updates_2025 #7

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
workflow_dispatch: # Allow manual trigger
# 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
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v3
with:
enable-cache: true
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install Java for PlantUML
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '17'
- name: Install PlantUML
run: |
sudo apt-get update
sudo apt-get install -y plantuml graphviz
- name: Install Python dependencies
run: |
uv sync --all-extras
- name: Cache PlantUML jar
uses: actions/cache@v4
with:
path: images/plantuml.jar
key: plantuml-jar-v1
- name: Validate topics
run: make validate
- name: Build documentation
run: make build
- name: Create .nojekyll file
run: touch doc/build/html/.nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: doc/build/html
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4