Improve docs pipeline with generated topology diagrams
This commit is contained in:
@@ -29,3 +29,17 @@ jobs:
|
||||
run: |
|
||||
test -d docs/public
|
||||
test -n "$(find docs/public -mindepth 1 -print -quit)"
|
||||
- name: Install Graphviz and MkDocs
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y graphviz
|
||||
dot -V
|
||||
python3 -m pip install --user mkdocs
|
||||
- name: Validate public docs and diagrams
|
||||
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
|
||||
python3 -m mkdocs build -f mkdocs-public.yml --strict
|
||||
|
||||
@@ -28,13 +28,26 @@ jobs:
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user