beatz174-bit
85 lines
2.1 KiB
YAML
85 lines
2.1 KiB
YAML
name: Publish documentation site
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
concurrency:
|
|
group: github-pages
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Ensure committed docs/public exists
|
|
run: |
|
|
test -d docs/public
|
|
test -n "$(find docs/public -mindepth 1 -print -quit)"
|
|
|
|
- name: Install Graphviz
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y graphviz
|
|
dot -V
|
|
|
|
- name: Validate sanitized diagram artifacts
|
|
run: |
|
|
test -f docs/public/physical-topology.svg
|
|
test -f docs/public/docker-traefik-dynu.svg
|
|
! rg -n "Graphviz dot not found" docs/public/*.svg
|
|
! rg -n "lan\.ddnsgeek\.com" docs/public/*.svg docs/public/*.md
|
|
! rg -n -i "password|token|api_key|secret" docs/public/*.svg
|
|
|
|
- name: Install MkDocs
|
|
run: |
|
|
python3 -m pip install --user mkdocs
|
|
|
|
- name: Build public MkDocs site
|
|
run: |
|
|
python3 -m mkdocs build -f mkdocs-public.yml --strict
|
|
|
|
- name: Verify published content excludes internal/generated docs
|
|
run: |
|
|
test -d site-public
|
|
test ! -e site-public/generated
|
|
test ! -e site-public/docker
|
|
|
|
- name: Verify expected 404-only paths are not generated
|
|
run: |
|
|
test ! -e site-public/generated/compose-inventory/index.html
|
|
test ! -e site-public/generated/prometheus-rules/index.html
|
|
test ! -e site-public/docker/index.html
|
|
|
|
- name: Configure GitHub Pages
|
|
uses: actions/configure-pages@v5
|
|
|
|
- name: Upload GitHub Pages artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: site-public
|
|
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|