Skip to content

Deploy MkDocs to GitHub Pages #2

Deploy MkDocs to GitHub Pages

Deploy MkDocs to GitHub Pages #2

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'cwe-*/**'
- '.github/workflows/deploy-docs.yml'
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
jobs:
generate-skill-index:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Generate Skill Index
run: |
python scripts/generate-skill-index.py
- name: Upload generated docs
uses: actions/upload-artifact@v4
with:
name: generated-docs
path: docs/skills/
deploy:
needs: generate-skill-index
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Download generated docs
uses: actions/download-artifact@v4
with:
name: generated-docs
path: docs/skills/
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install MkDocs and dependencies
run: |
pip install mkdocs-material pymdown-extensions
- name: Build MkDocs site
run: mkdocs build --strict
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
publish_branch: gh-pages
force_orphan: true