zack3d
2645951a3b
Doxygen to Wiki (Gitea-native) / Build Doxygen and publish to Wiki (push) Successful in 19s
114 lines
3.8 KiB
YAML
114 lines
3.8 KiB
YAML
# Publish Doxygen HTML to the repository Wiki via Gitea Actions
|
|
# Requirements:
|
|
# - Create a repository secret named WIKI_TOKEN with a Personal Access Token that has write access.
|
|
# - Ensure the Wiki is enabled for this repository.
|
|
# - Doxygen output is expected at docs/html (from Doxyfile: OUTPUT_DIRECTORY = docs).
|
|
|
|
name: Doxygen to Wiki (Gitea-native)
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
- master
|
|
paths:
|
|
- '**.py'
|
|
- '**.md'
|
|
- 'Doxyfile'
|
|
- '.gitea/workflows/doxygen-to-wiki.yml'
|
|
workflow_dispatch:
|
|
|
|
permissions: {}
|
|
|
|
jobs:
|
|
publish:
|
|
name: Build Doxygen and publish to Wiki
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Install Doxygen and tools
|
|
shell: bash
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y doxygen rsync
|
|
|
|
- name: Build Doxygen site
|
|
shell: bash
|
|
run: |
|
|
doxygen Doxyfile
|
|
test -d docs/html || { echo "Doxygen output not found at docs/html"; exit 2; }
|
|
|
|
- name: Publish to Wiki
|
|
env:
|
|
WIKI_TOKEN: ${{ secrets.WIKI_TOKEN }}
|
|
shell: bash
|
|
run: |
|
|
set -euo pipefail
|
|
|
|
if [ -z "${WIKI_TOKEN:-}" ]; then
|
|
echo "Missing WIKI_TOKEN secret. Create it with a PAT that has wiki write access." >&2
|
|
exit 1
|
|
fi
|
|
|
|
# Derive server host and repo slug from the existing 'origin' remote
|
|
ORIGIN_URL="$(git remote get-url origin)"
|
|
case "${ORIGIN_URL}" in
|
|
http://*|https://*)
|
|
SERVER_HOST="$(echo "${ORIGIN_URL}" | sed -E 's#^https?://([^/]+)/.*#\1#')"
|
|
PATH_PART="$(echo "${ORIGIN_URL}" | sed -E 's#^https?://[^/]+/##')"
|
|
;;
|
|
git@*:* )
|
|
SERVER_HOST="$(echo "${ORIGIN_URL}" | sed -E 's#^git@([^:]+):.*#\1#')"
|
|
PATH_PART="$(echo "${ORIGIN_URL}" | sed -E 's#^git@[^:]+:##')"
|
|
;;
|
|
*)
|
|
echo "Unsupported origin URL format: ${ORIGIN_URL}" >&2
|
|
exit 4
|
|
;;
|
|
esac
|
|
# Remove optional .git suffix
|
|
REPO_SLUG="${PATH_PART%.git}"
|
|
|
|
# Clone wiki with token via HTTP header (no username needed)
|
|
rm -rf wiki
|
|
WIKI_URL="https://${SERVER_HOST}/${REPO_SLUG}.wiki.git"
|
|
echo "Cloning wiki from ${WIKI_URL}"
|
|
git -c http.extraHeader="Authorization: token ${WIKI_TOKEN}" clone "${WIKI_URL}" wiki || {
|
|
echo "Wiki repo may not be initialized; create a placeholder page in the UI." >&2
|
|
exit 3
|
|
}
|
|
|
|
# Configure token for pushes to this host
|
|
git -C wiki config http."https://${SERVER_HOST}/".extraHeader "Authorization: token ${WIKI_TOKEN}"
|
|
|
|
# Sync generated HTML to wiki/doxygen
|
|
mkdir -p wiki/doxygen
|
|
rsync -a --delete --checksum docs/html/ wiki/doxygen/
|
|
|
|
# Seed landing page if missing
|
|
if [ ! -f "wiki/Doxygen.md" ]; then
|
|
printf "%s\n" \
|
|
"# Doxygen Documentation" \
|
|
"" \
|
|
"The generated API reference is published in this wiki under the doxygen directory." \
|
|
"" \
|
|
"- Open the HTML entry point: [doxygen/index.html](doxygen/index.html)" \
|
|
> wiki/Doxygen.md
|
|
fi
|
|
|
|
# Commit and push
|
|
COMMIT_SHA="$(git rev-parse --short HEAD || echo)"
|
|
cd wiki
|
|
git config user.name "wiki-bot"
|
|
git config user.email "wiki-bot@local"
|
|
git add -A
|
|
if git diff --cached --quiet; then
|
|
echo "No changes to publish."
|
|
exit 0
|
|
fi
|
|
git commit -m "docs: update doxygen site from ${COMMIT_SHA}"
|
|
git push origin HEAD |