53 lines
1.4 KiB
YAML
53 lines
1.4 KiB
YAML
name: Build & Deploy
|
|
|
|
on:
|
|
push:
|
|
pull_request:
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
# Build job
|
|
build:
|
|
# Specify runner + build & upload the static files as an artifact
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout code
|
|
id: checkout-code
|
|
uses: actions/checkout@v3
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.13'
|
|
cache: 'pip' # caching pip dependencies
|
|
- name: Install dependencies
|
|
id: install
|
|
run: |
|
|
pipx install poetry --python $(which python)
|
|
poetry install --only docs
|
|
- name: Build docs
|
|
id: build
|
|
run: |
|
|
mkdocs build
|
|
|
|
- name: Upload static files as artifact
|
|
id: deployment
|
|
uses: actions/upload-pages-artifact@v3 # or specific "vX.X.X" version tag for this action
|
|
with:
|
|
path: site/
|
|
|
|
# Deployment job
|
|
deploy:
|
|
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
|
|
permissions:
|
|
pages: write # to deploy to Pages
|
|
id-token: write # to verify the deployment originates from an appropriate source
|
|
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
|