Orkuncakilkaya
ccef707e4c
All checks were successful
docs / build-and-deploy (push) Successful in 11s
node:20-bookworm (the runner image) has no python3 and setup-python could not resolve; run the pure-Python generator in a python image and git-clone the public repo instead of relying on node-based actions. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
60 lines
2.2 KiB
YAML
60 lines
2.2 KiB
YAML
name: docs
|
|
|
|
# Rebuild the documentation site and publish it to the `pages` branch on every
|
|
# push to main that touches the docs sources. The site is generated from the
|
|
# per-symbol source of truth in docs/language/** — nothing is hand-edited on the
|
|
# pages branch.
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- 'docs/**'
|
|
- 'tools/docgen/**'
|
|
- '.forgejo/workflows/docs.yml'
|
|
workflow_dispatch: {}
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
jobs:
|
|
build-and-deploy:
|
|
runs-on: ubuntu-latest
|
|
# Run in a Python image: the generator is pure-Python stdlib, and this image
|
|
# already has git for the clone + publish. No node actions are used, so the
|
|
# job never depends on the runner's base image having python installed.
|
|
container: python:3.12
|
|
steps:
|
|
- name: Generate the documentation site
|
|
env:
|
|
SOURCE_REF: ${{ github.ref_name }}
|
|
run: |
|
|
set -eu
|
|
git config --global --add safe.directory '*'
|
|
git clone --depth 1 --branch "${SOURCE_REF:-main}" \
|
|
https://git.workshopsoft.io/workshopsoft/ludic.git src
|
|
python3 --version
|
|
python3 src/tools/docgen/gen.py --out public
|
|
python3 src/tools/docgen/check.py public
|
|
echo "--- generated files ---"
|
|
ls -la public
|
|
|
|
- name: Publish to the pages branch
|
|
env:
|
|
PAGES_TOKEN: ${{ secrets.PAGES_TOKEN }}
|
|
AUTO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
SOURCE_SHA: ${{ github.sha }}
|
|
run: |
|
|
set -eu
|
|
TOKEN="${PAGES_TOKEN:-${AUTO_TOKEN:-}}"
|
|
if [ -z "$TOKEN" ]; then
|
|
echo "::error::No deploy token. Add a repo secret PAGES_TOKEN (write access) or enable the automatic Actions token for pushes."
|
|
exit 1
|
|
fi
|
|
cd public
|
|
git init -q -b pages
|
|
git config user.name "ludic-docs-bot"
|
|
git config user.email "docs@workshopsoft.io"
|
|
git add -A
|
|
git commit -q -m "docs: regenerate site from ${SOURCE_SHA}"
|
|
git push -f "https://ludic-docs-bot:${TOKEN}@git.workshopsoft.io/workshopsoft/ludic.git" pages
|
|
echo "published $(git rev-parse --short HEAD) to pages"
|