# 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, Graphviz, jq, and doxybook2
shell: bash
run: |
set -euo pipefail
sudo apt-get update
sudo apt-get install -y doxygen graphviz rsync curl ca-certificates unzip jq
ARCH="$(uname -m)"
case "${ARCH}" in
x86_64|amd64) ARCH_TAG="amd64" ;;
aarch64|arm64) ARCH_TAG="arm64" ;;
*) echo "Unsupported architecture: ${ARCH}" >&2; exit 1 ;;
esac
# Discover latest linux asset for our arch from GitHub API
API_URL="https://api.github.com/repos/matusnovak/doxybook2/releases/latest"
ASSET_URL="$(curl -fsSL "${API_URL}" \
| jq -r --arg arch "${ARCH_TAG}" '.assets[] | select(.name | test("linux-" + $arch + "\\\\.(zip|tar\\\\.gz)$")) | .browser_download_url' \
| head -n1)"
# Fallback to known tar.gz naming if API parsing fails
if [ -z "${ASSET_URL}" ] || [ "${ASSET_URL}" = "null" ]; then
ASSET_URL="https://github.com/matusnovak/doxybook2/releases/latest/download/doxybook2-linux-${ARCH_TAG}.tar.gz"
fi
TMP="/tmp/doxybook2-asset"
rm -f "${TMP}.zip" "${TMP}.tar.gz" || true
if echo "${ASSET_URL}" | grep -qi '\.zip$'; then
curl -fsSL -o "${TMP}.zip" "${ASSET_URL}"
sudo unzip -j -o "${TMP}.zip" -d /usr/local/bin doxybook2
elif echo "${ASSET_URL}" | grep -qi '\.tar\.gz$'; then
curl -fsSL -o "${TMP}.tar.gz" "${ASSET_URL}"
sudo tar -xzf "${TMP}.tar.gz" -C /usr/local/bin doxybook2
else
echo "Unsupported asset type URL: ${ASSET_URL}" >&2
exit 1
fi
sudo chmod +x /usr/local/bin/doxybook2
doxybook2 --version
- name: Build Doxygen (HTML + XML)
shell: bash
run: |
set -euo pipefail
rm -rf docs/html docs/xml
doxygen Doxyfile
test -d docs/xml || { echo "Doxygen XML output not found at docs/xml"; 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}"
# Convert Doxygen XML to Markdown into wiki/Doxygen
rm -rf wiki/Doxygen wiki/doxygen
mkdir -p wiki/Doxygen
doxybook2 --input docs/xml --output wiki/Doxygen
# Create/overwrite the landing page
cat > wiki/Doxygen.md << 'EOF'
# Doxygen Documentation
The generated API reference is published as native Markdown pages under the Doxygen directory in this wiki.
- Open the entry point (if present): [Doxygen/index.md](Doxygen/index.md)
- Or browse the Doxygen/ pages listed in the sidebar
EOF
# 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