Skip to content

Docs fixes (#6)

Docs fixes (#6) #9

Workflow file for this run

name: docs
on:
push:
branches: [ main ]
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/docs.yml'
pull_request:
branches: [ main ]
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
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
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Cache pip dependencies
uses: actions/cache@v4
with:
key: mkdocs-${{ hashFiles('mkdocs.yml') }}
path: ~/.cache/pip
restore-keys: mkdocs-
- name: Install MkDocs
run: pip install mkdocs-material mkdocs-mermaid2-plugin mkdocs-swagger-ui-tag
- name: Download OpenAPI spec
run: |
curl -s https://api.integr8scode.cc/openapi.json | \
jq '. + {servers: [{url: "https://api.integr8scode.cc", description: "Production"}]}' \
> docs/reference/openapi.json
- name: Build documentation
run: mkdocs build --strict
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: site/
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
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