44 lines
1.1 KiB
YAML
44 lines
1.1 KiB
YAML
name: Generate and deploy API documentation
|
|
|
|
on:
|
|
release:
|
|
types: [published]
|
|
workflow_dispatch:
|
|
|
|
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:
|
|
# Single deploy job since we're just deploying
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4.1.7
|
|
- name: Set up PDM
|
|
uses: pdm-project/setup-pdm@v4.1
|
|
with:
|
|
python-version: "3.9"
|
|
- run: pdm sync
|
|
- run: pdm run docs
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v5.0.0
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3.0.1
|
|
with:
|
|
path: "docs/"
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4.0.5
|