fixing wiki generation
Generate and publish developer Wiki / generated-wiki (pull_request) Successful in 14s

This commit is contained in:
2026-07-19 21:32:10 +00:00
parent 8bf3e03de8
commit f5d14b0a79
13 changed files with 105 additions and 62 deletions
+42 -5
View File
@@ -1,9 +1,15 @@
name: Validate source documentation
name: Generate and publish developer Wiki
on:
pull_request:
push:
branches: [main]
workflow_dispatch:
concurrency:
group: openunifi-wiki
cancel-in-progress: false
permissions:
code: read
@@ -11,10 +17,41 @@ jobs:
generated-wiki:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check out source repository
uses: actions/checkout@v4
with:
fetch-depth: 2
- name: Check generated Gitea Wiki pages
run: ./scripts/docs/generate-wiki.py --check
path: source
- name: Check patch whitespace
run: git diff --check HEAD^
run: git -C source diff --check HEAD^ HEAD
- name: Validate documentation generator
run: |
mkdir -p "$RUNNER_TEMP/openuf-wiki"
python3 source/scripts/docs/generate-wiki.py --output "$RUNNER_TEMP/openuf-wiki"
python3 source/scripts/docs/generate-wiki.py --check --output "$RUNNER_TEMP/openuf-wiki"
- name: Check out Wiki repository
if: github.event_name != 'pull_request'
uses: actions/checkout@v4
with:
repository: Koda/openunifi.wiki
token: ${{ secrets.GITEA_TOKEN }}
path: wiki
- name: Generate and verify Gitea Wiki pages
if: github.event_name != 'pull_request'
run: |
python3 source/scripts/docs/generate-wiki.py --output wiki
python3 source/scripts/docs/generate-wiki.py --check --output wiki
- name: Publish changed Wiki pages
if: github.event_name != 'pull_request'
working-directory: wiki
run: |
set -eu
git config user.name "openUF documentation bot"
git config user.email "actions@openuf.invalid"
git add -- Home.md Developer-Guide.md Call-Graph.md Runtime-Flow.md _Sidebar.md
if git diff --cached --quiet; then
echo "Gitea Wiki is already current"
exit 0
fi
git commit -m "docs: update generated developer wiki"
git push origin HEAD
+5 -2
View File
@@ -22,8 +22,11 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Verify generated developer Wiki
run: ./scripts/docs/generate-wiki.py --check
- name: Validate documentation generator
run: |
mkdir -p "$RUNNER_TEMP/openuf-wiki"
python3 ./scripts/docs/generate-wiki.py --output "$RUNNER_TEMP/openuf-wiki"
python3 ./scripts/docs/generate-wiki.py --check --output "$RUNNER_TEMP/openuf-wiki"
- name: Install metadata dependencies
run: sudo apt-get update && sudo apt-get install --yes jq
- name: Read release configuration