mirror of
https://github.com/SpecterOps/Nemesis
synced 2026-06-08 12:36:42 +00:00
Lee Chagolla-Christensen
432d08157d
Replace version tag references for external GitHub Actions with full commit SHAs while retaining the source tag as an inline comment.
73 lines
1.9 KiB
YAML
73 lines
1.9 KiB
YAML
name: Generate API Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- 'projects/web_api/**'
|
|
- '.github/workflows/generate-api-docs.yml'
|
|
- '.github/scripts/generate_api_docs.py'
|
|
workflow_dispatch: # For manual triggering
|
|
|
|
jobs:
|
|
generate-docs:
|
|
runs-on: ubuntu-22.04
|
|
|
|
permissions:
|
|
contents: write
|
|
pages: write
|
|
id-token: write
|
|
|
|
environment:
|
|
name: github-pages
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
|
|
|
|
- name: Setup Python 3.12
|
|
run: uv python install 3.12
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
cd projects/web_api
|
|
uv sync --frozen
|
|
|
|
- name: Generate API documentation
|
|
run: |
|
|
cd projects/web_api
|
|
uv run python ../../.github/scripts/generate_api_docs.py
|
|
|
|
- name: Commit documentation changes
|
|
uses: stefanzweifel/git-auto-commit-action@04702edda442b2e678b25b537cec683a1493fcb9 # v7
|
|
with:
|
|
commit_message: 'docs: update API documentation [skip ci]'
|
|
file_pattern: 'docs/*'
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Install mkdocs dependencies
|
|
run: |
|
|
uv venv
|
|
uv pip install -r docs/requirements.txt
|
|
|
|
- name: Build documentation
|
|
run: |
|
|
uv run mkdocs build
|
|
|
|
- name: Setup Github pages
|
|
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5
|
|
|
|
- name: Create Github pages artifact
|
|
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
|
|
with:
|
|
path: site
|
|
|
|
- name: Deploy documentation to Github pages
|
|
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
|