AlexandClaude Opus 4.8
33223d5534
Improve the generated wiki pages: - normalize definition-style option blocks (*name*: / typeof: / default:) into scdoc tables, so every module renders options as a clean table like the table-style pages (Bluetooth, Network, ... no longer a wall of text) - drop pandoc's empty leading table-header row so the real header shows - pin pandoc to 3.5 in CI (the distro 2.x man reader mangled lists into blockquotes); matches local output - prepend a visible "auto-generated from master, do not edit here" note to every page (was an invisible HTML comment) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
66 lines
2.1 KiB
YAML
66 lines
2.1 KiB
YAML
name: Sync wiki from man pages
|
|
|
|
# The scdoc man pages under man/ are the single source of truth for module
|
|
# documentation. This workflow regenerates the corresponding GitHub wiki pages
|
|
# whenever a man page (or the sync tooling) changes on the default branch.
|
|
#
|
|
# Only the pages listed in .github/wiki/mapping.json are (re)written; every
|
|
# other wiki page (Home, Installation, user showcases, ...) is left untouched.
|
|
|
|
on:
|
|
push:
|
|
branches: [master]
|
|
paths:
|
|
- 'man/**'
|
|
- '.github/wiki/**'
|
|
- '.github/workflows/wiki.yml'
|
|
workflow_dispatch: {}
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
concurrency:
|
|
group: wiki-sync
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
sync:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Install scdoc and pandoc
|
|
# pandoc is pinned: the distro package can be an old 2.x whose man reader
|
|
# mangles lists into blockquotes. Keep this in sync with local tooling.
|
|
env:
|
|
PANDOC_VERSION: "3.5"
|
|
run: |
|
|
sudo apt-get update && sudo apt-get install -y scdoc
|
|
curl -fsSL -o /tmp/pandoc.deb \
|
|
"https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-1-amd64.deb"
|
|
sudo dpkg -i /tmp/pandoc.deb
|
|
pandoc --version | head -1
|
|
|
|
- name: Clone the wiki
|
|
run: |
|
|
git clone \
|
|
"https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git" \
|
|
wiki
|
|
|
|
- name: Generate wiki pages from man pages
|
|
run: python3 .github/wiki/generate.py --man-dir man --out-dir wiki
|
|
|
|
- name: Commit and push if changed
|
|
working-directory: wiki
|
|
run: |
|
|
git config user.name "github-actions[bot]"
|
|
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
git add -A
|
|
if git diff --staged --quiet; then
|
|
echo "Wiki already up to date."
|
|
else
|
|
git commit -m "docs: sync module pages from man (${{ github.sha }})"
|
|
git push
|
|
fi
|