blob: ba47ea5377cc6a8013cede77556e732091525a73 [file] [log] [blame]
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +02001#!/bin/sh
Matthias Andreas Benkard7d46f072026-08-24 21:43:05 +02002# SPDX-FileCopyrightText: 2026 Matthias Andreas Benkard <code@mail.matthias.benkard.de>
Matthias Andreas Benkarda5d55442026-08-23 08:31:49 +02003# SPDX-License-Identifier: AGPL-3.0-or-later
4
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +02005# Macht aus dem Übersetzerergebnis ein auslieferbares Verzeichnis. Läuft in der Phase
6# „package“ des Profils -Pwasm, unmittelbar nach native-image.
7#
8# 1. Der Textzwischenschritt aendggner.js.wat (mehrere hundert Megabyte) wird entfernt.
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +02009# 2. Das Modul geht durch wasm-opt -Oz, sofern Binaryen zur Hand ist.
10# 3. Der Quelltext der gebauten Fassung wird als Tarball beigelegt — AGPLv3 §13 verlangt
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +020011# beim Netzwerkbetrieb einen Quellcode-Zugang für die Nutzer:innen, und der Footer der
12# Startseite verweist darauf.
Matthias Andreas Benkardc1013fc2026-08-29 07:24:42 +020013# 4. Die Startseite bekommt unter dem Titel das Datum des gebauten Commits.
14# 5. Nur die vom Bau erzeugten Dateien bleiben stehen; alles hier Liegende wird
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +020015# hochgeladen.
Matthias Andreas Benkardc1013fc2026-08-29 07:24:42 +020016# 6. Auf Wunsch (VORKOMPRIMIEREN=1) werden die großen Dateien vorkomprimiert.
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +020017#
18# Zielplattform ist Cloudflare Workers: dort gilt eine Grenze von 25 MiB je Datei
19# (unkomprimiert), und komprimiert wird beim Ausliefern ohnehin. Deshalb ist die
20# Vorkompression abgeschaltet und die Größe jeder Datei wird geprüft. Wer stattdessen
21# selbst mit nginx ausliefert (deploy/nginx-aendggner.conf, gzip_static/brotli_static),
22# ruft das Skript mit VORKOMPRIMIEREN=1 auf.
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +020023#
24# Aufruf: deploy/webpaket.sh <ausgabeverzeichnis> (Standard: target/web)
25
26set -eu
27
28ziel="${1:-target/web}"
29quelle="$(CDPATH='' cd -- "$(dirname -- "$0")/.." && pwd)"
30
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +020031# Cloudflare Workers nimmt keine Datei über 25 MiB an.
32grenze_datei=26214400
33# Der Quelltext misst ein Viertel Megabyte. Wächst das Archiv über diese Schranke, sind
34# wieder Massendaten ins Repository geraten, die dort nicht hingehören (siehe
35# .gitattributes) — dann lieber der Bau ab als ein unbrauchbares Paket.
36grenze_archiv=8388608
37
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +020038if [ ! -d "$ziel" ]; then
39 echo "webpaket: $ziel gibt es nicht — erst -Pwasm package laufen lassen." >&2
40 exit 1
41fi
42
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +020043groesse() {
44 wc -c <"$1" | tr -d ' '
45}
46
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +020047# 1. Zwischenschritt fort.
48rm -f "$ziel/aendggner.js.wat"
49
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +020050# 2. Nachoptimierung. -Oz zieht die Codegröße noch einmal spürbar zusammen.
51#
52# Die Merkmale sind einzeln aufgezählt, nicht als --all-features: Binaryen darf ausgeben,
53# was es darf, und mit --all-features nutzt es auch Vorschläge, die noch kein Browser
54# annimmt — das Modul scheitert dann erst beim Instanziieren („invalid heap type 'exact'“
55# aus den custom descriptors, „invalid import kind 127“ aus der kompakten
56# Importsektion). Aufgeführt ist deshalb nur, was ausgeliefert in den Browsern steht und
57# was Web Image braucht: WasmGC samt Referenztypen, das Ausnahmen-Proposal, endständige
58# Aufrufe. Fehlt wasm-opt, bleibt das Modul, wie es ist — der Bau soll daran nicht
59# scheitern.
60wasm_merkmale="--enable-gc --enable-reference-types --enable-exception-handling
61 --enable-tail-call --enable-bulk-memory --enable-bulk-memory-opt
62 --enable-nontrapping-float-to-int --enable-sign-ext
63 --enable-mutable-globals --enable-multivalue --enable-extended-const
64 --enable-simd --enable-call-indirect-overlong"
65
66if [ -f "$ziel/aendggner.js.wasm" ]; then
67 vorher="$(groesse "$ziel/aendggner.js.wasm")"
68 if command -v wasm-opt >/dev/null 2>&1; then
69 # shellcheck disable=SC2086 # die Merkmalsliste soll in Wörter zerfallen
70 wasm-opt $wasm_merkmale -Oz \
71 -o "$ziel/aendggner.js.wasm.neu" "$ziel/aendggner.js.wasm"
72 mv "$ziel/aendggner.js.wasm.neu" "$ziel/aendggner.js.wasm"
73 echo "webpaket: wasm-opt: $vorher -> $(groesse "$ziel/aendggner.js.wasm") Bytes."
74 else
75 echo "webpaket: wasm-opt nicht gefunden — Modul bleibt unnachoptimiert" \
76 "($vorher Bytes)." >&2
77 fi
78fi
79
80# 3. Quelltext der gebauten Fassung.
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +020081#
82# Ein veränderter Arbeitsbaum bricht den Bau ab: Der angebotene Quelltext muss der
83# ausgelieferten Fassung entsprechen, sonst ist die Auflage aus §13 verfehlt. Wer nur
84# ausprobieren will, setzt QUELLTEXT_UNGEPRUEFT=1.
85if ! git -C "$quelle" rev-parse --git-dir >/dev/null 2>&1; then
86 echo "webpaket: $quelle ist kein Git-Arbeitsbaum; ohne ihn lässt sich der Quelltext" >&2
87 echo " der gebauten Fassung nicht beilegen (AGPLv3 §13)." >&2
88 exit 1
89fi
90
91if [ -n "$(git -C "$quelle" status --porcelain)" ] && [ "${QUELLTEXT_UNGEPRUEFT:-}" != 1 ]; then
92 echo "webpaket: Der Arbeitsbaum trägt uneingecheckte Änderungen. Der beigelegte Quelltext" >&2
93 echo " wäre dann nicht der gebaute. Erst einchecken — oder für einen Probelauf" >&2
94 echo " QUELLTEXT_UNGEPRUEFT=1 setzen (dann nicht ausliefern)." >&2
95 exit 1
96fi
97
98fassung="$(git -C "$quelle" rev-parse HEAD)"
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +020099archiv="$(CDPATH='' cd -- "$ziel" && pwd)/aendggner-quelltext.tar.gz"
100git -C "$quelle" archive --format=tar.gz --prefix=aendggner/ HEAD -o "$archiv"
101
102archivgroesse="$(groesse "$archiv")"
103if [ "$archivgroesse" -gt "$grenze_archiv" ]; then
104 echo "webpaket: Das Quelltextarchiv misst $archivgroesse Bytes und überschreitet damit" >&2
105 echo " die Schranke von $grenze_archiv. Vermutlich sind Massendaten ins" >&2
106 echo " Repository geraten; sie gehören in .gitattributes (export-ignore)." >&2
107 exit 1
108fi
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +0200109
110{
111 echo "ÄndGgner — Quelltext der ausgelieferten Fassung"
112 echo
113 echo "Commit: $fassung"
Matthias Andreas Benkardc1013fc2026-08-29 07:24:42 +0200114 echo "Fassung: $(git -C "$quelle" log -1 --format=%cs HEAD)"
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +0200115 echo "Gebaut: $(date -u '+%Y-%m-%dT%H:%M:%SZ')"
116 echo
Matthias Andreas Benkard8cbbaaa2026-08-23 13:20:48 +0200117 echo "Vollständig in aendggner-quelltext.tar.gz; Bauanleitung darin in README.md."
Matthias Andreas Benkard08aa3032026-08-23 13:21:55 +0200118 echo "Fortlaufend: https://git.benkard.de/mulk/aendggner"
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +0200119 echo
120 echo "Nicht im Archiv liegt der Beispielkorpus (src/test/resources/sampledata): Gesetzes-"
121 echo "und Drucksachentexte fremder Urheberschaft, an denen die Tests messen. Gebaut wird"
122 echo "ohne ihn; nur die Tests verlangen danach. Wer sie laufen lassen will, holt das"
123 echo "Repository von der oben genannten Adresse, wo der Korpus vollständig liegt."
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +0200124} > "$ziel/quelltext-fassung.txt"
125
Matthias Andreas Benkardc1013fc2026-08-29 07:24:42 +0200126# 4. Fassungsdatum der Startseite.
127#
128# Unter dem Titel steht „in der Fassung vom …“. Im Quelltext trägt die Marke das Datum des
129# letzten Handanlegens; ausgeliefert wird das Datum des gebauten Commits, damit die Angabe
130# nicht stillschweigend veraltet. Das Datum kommt aus %cs (JJJJ-MM-TT); date(1) bleibt
131# außen vor, weil BSD und GNU sich über die Schalter nicht einig sind.
132fassungsdatum="$(git -C "$quelle" log -1 --format=%cs HEAD)"
133jahr="${fassungsdatum%%-*}"
134rest="${fassungsdatum#*-}"
135monat="${rest%%-*}"
136tag="${rest#*-}"
137
138case "$monat" in
139 01) monatsname="Januar" ;; 02) monatsname="Februar" ;; 03) monatsname="März" ;;
140 04) monatsname="April" ;; 05) monatsname="Mai" ;; 06) monatsname="Juni" ;;
141 07) monatsname="Juli" ;; 08) monatsname="August" ;; 09) monatsname="September" ;;
142 10) monatsname="Oktober" ;; 11) monatsname="November" ;; 12) monatsname="Dezember" ;;
143 *) echo "webpaket: unlesbares Commit-Datum „$fassungsdatum“." >&2; exit 1 ;;
144esac
145
146# Führende Null im Tag ist im deutschen Fließtext unüblich.
147tag="${tag#0}"
148fassungstext="$tag. $monatsname $jahr"
149
150startseite="$ziel/index.html"
151if [ ! -f "$startseite" ]; then
152 echo "webpaket: $startseite fehlt — die statischen Seiten sind nicht mitkopiert." >&2
153 exit 1
154fi
155
156sed -e "s|<time datetime=\"[0-9-]*\">[^<]*</time>|<time datetime=\"$fassungsdatum\">$fassungstext</time>|" \
157 "$startseite" > "$startseite.neu"
158
159# Greift die Ersetzung nicht, ist die Marke im Vordruck umgebaut worden. Dann lieber der
160# Bau ab als eine falsch datierte Fassung.
161if ! grep -q "<time datetime=\"$fassungsdatum\">$fassungstext</time>" "$startseite.neu"; then
162 rm -f "$startseite.neu"
163 echo "webpaket: In index.html ist keine <time>-Marke unter dem Titel zu finden; das" >&2
164 echo " Fassungsdatum lässt sich nicht einsetzen." >&2
165 exit 1
166fi
167mv "$startseite.neu" "$startseite"
168echo "webpaket: Startseite trägt die Fassung vom $fassungstext."
169
170# 5. Nur das Gebaute bleibt liegen — was hier steht, geht hoch.
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +0200171rm -f "$ziel/.DS_Store"
172
Matthias Andreas Benkardc1013fc2026-08-29 07:24:42 +0200173# 6. Vorkompression, nur auf Anforderung (siehe Kopf). Der Tarball ist bereits gepackt und
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +0200174# bleibt außen vor.
175if [ "${VORKOMPRIMIEREN:-}" = 1 ]; then
176 for datei in "$ziel"/*.wasm "$ziel"/*.js "$ziel"/*.css "$ziel"/*.html "$ziel"/*.svg \
177 "$ziel"/*.txt; do
178 [ -f "$datei" ] || continue
179 gzip -9 -f -k -- "$datei"
180 if command -v brotli >/dev/null 2>&1; then
181 brotli -f -- "$datei"
182 fi
183 done
184
185 if ! command -v brotli >/dev/null 2>&1; then
186 echo "webpaket: brotli nicht gefunden — nur .gz angelegt." >&2
187 fi
188fi
189
190# Was zu groß ist, nimmt Cloudflare nicht an. Lieber hier auffallen als beim Hochladen.
191zugross=""
192for datei in "$ziel"/*; do
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +0200193 [ -f "$datei" ] || continue
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +0200194 if [ "$(groesse "$datei")" -gt "$grenze_datei" ]; then
195 zugross="$zugross $(basename "$datei") ($(groesse "$datei") Bytes)
196"
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +0200197 fi
198done
Matthias Andreas Benkardf3b47af2026-08-22 21:23:06 +0200199if [ -n "$zugross" ]; then
200 echo "webpaket: Diese Dateien überschreiten die 25-MiB-Grenze von Cloudflare Workers:" >&2
201 printf '%s' "$zugross" >&2
202 exit 1
Matthias Andreas Benkard2d33bf72026-08-16 06:40:07 +0200203fi
204
205echo "webpaket: $ziel ist auslieferbar (Fassung $(git -C "$quelle" rev-parse --short HEAD))."