Files
werkbaum/.github/workflows/pages.yml
T
mhoennigandClaude Opus 5 48d3174684 feat(site): llms.txt als Wegweiser + Charset-Fix für llms.md
Anlass war die Frage, ob `llms.md` ein guter Name ist. Zwei Befunde:

1. Der Zweck der Konvention ist ein anderer, als D43 annahm. llmstxt.org
   über die eigene Datei: „a markdown file that provides brief background
   information and guidance, along with links to markdown files providing
   more detailed information“ — ein Index, kein Inhalt. Der 211-Zeilen-
   Leitfaden ist genau eine jener verlinkten Dateien; `llms.md` ist damit
   der richtige Name, es fehlte der Wegweiser davor.

2. `llms.md` kam auf der stabilen Instanz falsch kodiert an: Apache kennt
   `.md` nicht und sendet GAR KEINEN Content-Type, der Browser rät
   windows-1252. Gemessen: characterSet=windows-1252, aus „notation —
   guide“ wurde „notation â€" guide“, 31 Zeilen betroffen. GitHub Pages
   liefert dieselbe Datei korrekt als text/markdown; charset=utf-8 aus.

- frontend/public/llms.txt: Index nach der Konvention (Titel, Blockquote,
  Notation in Kurzform, ## Docs, ## Optional). Rein ASCII — er ist die
  Datei, die ein fremder Agent ungefragt abruft, und soll auch dort
  ankommen, wo ein Server die Kodierung verschweigt. Alle 5 Links: 200.
- scripts/prod.htaccess: AddType für .md/.txt/.werkbaum, von
  deploy-prod.sh als .htaccess gespiegelt. Nicht in public/ — dort landete
  es wirkungslos im Pages-Artefakt. Rückweg bei 500 steht in der Datei.
- Beide Deploy-Wege kopieren llms.txt mit.

SPEC §13 + D43-Nachtrag 2 (mit Richtigstellung der D43-Annahme);
Plan: #not.llms.index [x]. 243 Tests grün, Plan 157 Knoten, 0 Warnungen.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-24 11:01:51 +02:00

110 lines
4.5 KiB
YAML

name: Deploy to GitHub Pages
# Veröffentlicht den Frontend-Editor als statische Seite auf GitHub Pages.
# Einmalige Voraussetzung: Repo-Settings → Pages → Source = "GitHub Actions"
# (Repo muss dafür öffentlich sein). Siehe README.md, Abschnitt „Deployment".
on:
push:
branches: [main]
workflow_dispatch:
# Nur Leserechte auf den Code, plus die für die Pages-Deployment-Actions
# nötigen Sonderrechte: pages (Deployment schreiben) und id-token (OIDC-Token,
# das actions/deploy-pages zur Authentifizierung braucht).
permissions:
contents: read
pages: write
id-token: write
# Läuft immer nur ein Deployment gleichzeitig; neue Pushes warten, laufende
# werden nicht abgebrochen (cancel-in-progress: false), damit ein Deploy nicht
# mittendrin unterbrochen wird.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
with:
# Volle Historie: die Micro-Version wird aus der Commit-Anzahl
# abgeleitet (Standard wäre ein flacher Klon mit nur einem Commit).
fetch-depth: 0
# Node einrichten und den Vite-Build fahren (D19): der Editor liegt jetzt
# als ES-Module unter frontend/src/, Vite bündelt sie zu EINER
# self-contained frontend/dist/index.html (JS+CSS+Favicon inline). Tests
# laufen zuerst — schlägt Vitest fehl, wird nicht deployt.
# Hinweis: der Default-`npm run build` trägt den 🚧-„latest build"-Hinweis
# hinter dem Titel automatisch in sich (app.js/mountBuildBadge, D16) — der
# Pages-Deploy ist bewusst der latest build. Nur `build:prod` ließe ihn weg.
- name: Node einrichten
uses: actions/setup-node@v5
with:
node-version: 24
cache: npm
cache-dependency-path: frontend/package-lock.json
- name: Abhängigkeiten installieren
run: npm ci --prefix frontend
- name: Tests
run: npm test --prefix frontend
- name: Build (Vite)
run: npm run build --prefix frontend
# Site-Ordner zusammenstellen: die gebaute dist/index.html an die
# Wurzel-URL, dazu LICENSE für den MIT-Link im Footer. Das Favicon ist im
# Build bereits als data:-URI inline (kein docs/brand-Kopieren mehr nötig).
# Im Footer werden gesetzt:
# - die Versionsnummer: Major.Minor aus der VERSION-Datei (per
# Bump-Commit gepflegt), die Micro-Stelle aus der Anzahl der Commits
# seit dem letzten VERSION-Bump — steigt also je Commit und beginnt
# nach einem Bump wieder bei 0 (z. B. 1.0.7).
# - der Link der Versionsnummer: zeigt exakt auf den deployten Commit
# (…/commit/<sha>). „Werkbaum" selbst verlinkt weiter die Repo-
# Startseite. Braucht die volle Historie (fetch-depth: 0).
# Der ../LICENSE-Link ist eine Laufzeit-Verknüpfung (kein Vite-Asset) und
# zeigt von der Wurzel-URL aus sonst über die Site hinaus — daher hier auf
# der Kopie geradegezogen.
- name: Site zusammenstellen
run: |
MAJORMINOR="$(tr -d '[:space:]' < VERSION)"
BASE="$(git log -1 --format=%H -- VERSION)" # letzter Bump-Commit
[ -z "$BASE" ] && BASE="$(git rev-list --max-parents=0 HEAD | tail -1)"
MICRO="$(git rev-list --count "${BASE}..HEAD")" # Commits seit dem Bump
BUILD_VERSION="${MAJORMINOR}.${MICRO}"
COMMIT_URL="https://github.com/mhoennig/werkbaum/commit/$(git rev-parse HEAD)"
echo "Footer-Version: ${BUILD_VERSION} -> ${COMMIT_URL}"
mkdir -p site
sed -e 's#\.\./LICENSE#LICENSE#g' \
-e "s#\(<a class=\"ver\" href=\"\)[^\"]*#\1${COMMIT_URL}#" \
-e "s#\(<a class=\"ver\"[^>]*>\)[0-9.]\+</a>#\1${BUILD_VERSION}</a>#" \
frontend/dist/index.html > site/index.html
cp LICENSE site/LICENSE
# Agenten-Fassung der Notation (D43) — liegt per Vite-public/ in dist/
cp frontend/dist/llms.md site/llms.md
# Wegweiser der llms.txt-Konvention (D43-Nachtrag 2)
cp frontend/dist/llms.txt site/llms.txt
- name: Pages-Konfiguration
uses: actions/configure-pages@v6
- name: Artefakt hochladen
uses: actions/upload-pages-artifact@v5
with:
path: site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Auf GitHub Pages deployen
id: deployment
uses: actions/deploy-pages@v5