Skip to content

Merge pull request #67 from IlyaChichkov/develop #45

Merge pull request #67 from IlyaChichkov/develop

Merge pull request #67 from IlyaChichkov/develop #45

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches: [ master ]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y libcairo2-dev pkg-config python3-dev
# Added pyyaml to ensure the scripts have it available
pip install cairosvg pycairo mkdocs mkdocs-material mkdocs-mermaid2-plugin mkdocs-minify-plugin mkdocs-macros-plugin mkdocs-llmstxt mkdocs-static-i18n pyyaml
- name: Format, Fix, and Validate API Docs
run: |
echo "🧹 Formatting YAML files..."
python scripts/docs/mkdocs_format_yaml.py
echo "🔧 Auto-fixing HTTP methods..."
python scripts/docs/mkdocs_fix_yaml_methods.py
echo "🔍 Running final validation check..."
python scripts/docs/mkdocs_check_api.py
- name: Build site
run: mkdocs build --site-dir public
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './public'
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