Unifi-Voucher-Tool/.github/workflows/release.yml
Friederich Loheide 25b8c51362
Some checks failed
CI / PHP Lint-1 (push) Successful in 43s
CI / PHP Lint (push) Successful in 45s
CI / PHP Lint (pull_request) Successful in 38s
CI / Unit Tests & Static Analysis (push) Failing after 43s
CI / PHP Lint-1 (pull_request) Successful in 40s
CI / Unit Tests & Static Analysis (pull_request) Failing after 41s
Selbst-Updater neu gebaut, Diagnoseseiten abgesichert
Aktualisierung per Klick im Administrationsbereich, ohne Zugang zum
Server. Der bisherige Updater lud ein ZIP und entpackte es ungeprüft über
die Produktion; das ist vollständig ersetzt.

Neu in updater/:

- Version: Release-Version als Konstante, installierter Commit-SHA in
  storage/.version (Datei, nicht Datenbank - der Updater muss den Stand
  auch bei hängender Datenbank lesen können)
- Progress: Fortschrittsdatei mit eigenem Fehlerzustand (pct = -1) und
  Verfallszeit, damit ein abgestürzter Lauf den nächsten nicht blockiert
- Maintenance: Wartungsmarkierung mit Ablauf, die sich beim Prüfen selbst
  aufräumt
- ProxyClient: nur HTTPS, Zertifikatsprüfung an, begrenzte
  Weiterleitungen, 503 mirror_pending/not_released als Bitte um Geduld
- Updater: Prüfsumme gegen X-Content-Sha256, zweistufiger ZIP-Slip-Schutz,
  geschützte Pfade, atomares Schreiben je Datei, nie löschen
- AutoMigrate: zieht Migrationen beim ersten Seitenaufruf nach, nur bei
  geändertem Fingerabdruck und mit Sperre gegen Parallellauf
- guard.php: Wartungs-Wächter für die Einstiegsseiten, JSON für die
  Schnittstellen; ausgenommen bleiben Update-Seite, Anmeldung und
  Health-Check
- Changelog: zerlegt CHANGELOG.md und rendert Markdown ohne unsichere Links

Oberfläche: Seite "Aktualisierung" mit Stand, Kanal, Suche, Fortschritt,
Migrationsliste und Versionsgeschichte. Der Datenschutzhinweis steht
dauerhaft neben der Schaltfläche, nicht in einem Dialog.

Fehlt changelog_preview in der Antwort, bleibt es bei "neue Fassung
verfügbar" - kein leerer Kasten, kein erfundener Ersatztext. Commit-Texte
werden nirgends angezeigt.

Außerdem (Punkt 2 der Liste):

- cron_test.php entfernt: ohne jede Anmeldung erreichbar, meldete
  Datenbankfehler samt Meldung und die Spalten der vouchers-Tabelle
- test.php verweigert ohne config.php die Auskunft; bisher lief die
  Diagnose auf einer frisch entpackten Installation ohne Anmeldung

PHPStan prüft jetzt den gesamten updater/-Ordner. 18 neue Tests
(93 Tests, 243 Assertions), Ablauf gegen den echten Update-Dienst
durchgespielt.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-25 19:49:59 +00:00

235 lines
10 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

name: Release-Paket
# Bei jedem Merge nach main entsteht ein installierbares ZIP und landet als
# Vorab-Release "latest-main" im Repository. Wird ein Tag v* gepusht, wird
# daraus ein regulaeres Release mit derselben Mechanik.
on:
push:
branches: [ main ]
tags: [ 'v*' ]
workflow_dispatch:
jobs:
package:
name: ZIP bauen und veröffentlichen
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Version und Dateinamen bestimmen
id: meta
run: |
set -eu
VERSION="$(tr -d ' \r\n' < VERSION)"
SHORT_SHA="$(git rev-parse --short HEAD)"
BUILD_DATE="$(date -u +%Y-%m-%d)"
if [ "${GITHUB_REF_TYPE:-branch}" = "tag" ]; then
TAG="${GITHUB_REF_NAME}"
NAME="unifi-voucher-tool-${TAG}"
TITLE="Version ${TAG}"
PRERELEASE="false"
else
TAG="latest-main"
NAME="unifi-voucher-tool-${VERSION}+${BUILD_DATE}.${SHORT_SHA}"
TITLE="Aktueller Stand von main – ${VERSION} (${SHORT_SHA})"
PRERELEASE="true"
fi
{
echo "version=${VERSION}"
echo "short_sha=${SHORT_SHA}"
echo "build_date=${BUILD_DATE}"
echo "tag=${TAG}"
echo "name=${NAME}"
echo "title=${TITLE}"
echo "prerelease=${PRERELEASE}"
} >> "$GITHUB_OUTPUT"
- name: ZIP erzeugen
run: |
set -eu
mkdir -p dist
# git archive wertet die export-ignore-Regeln aus .gitattributes aus,
# docs/, tests/, tools/ und CI-Dateien bleiben also draußen.
git archive --format=zip -9 \
--prefix="unifi-voucher-tool/" \
-o "dist/${{ steps.meta.outputs.name }}.zip" HEAD
cd dist
sha256sum "${{ steps.meta.outputs.name }}.zip" > "${{ steps.meta.outputs.name }}.zip.sha256"
ls -lh
- name: Inhalt kurz prüfen
run: |
set -eu
# Die Dateiliste einmal erzeugen und danach nur noch darin suchen.
# Frueher lief hier "unzip -l | grep -q" je Datei: grep beendet sich
# beim ersten Treffer, unzip stirbt an SIGPIPE, und mit pipefail galt
# die Pruefung als fehlgeschlagen - aber nur fuer Dateien, die frueh
# in der Liste stehen.
unzip -Z1 "dist/${{ steps.meta.outputs.name }}.zip" > /tmp/zip-inhalt.txt
# Ein paar Dateien muessen enthalten sein, sonst ist das Paket kaputt.
for required in \
unifi-voucher-tool/index.php \
unifi-voucher-tool/install.php \
unifi-voucher-tool/database.sql \
unifi-voucher-tool/LICENSE \
unifi-voucher-tool/THIRD-PARTY-NOTICES.md \
unifi-voucher-tool/CHANGELOG.md \
unifi-voucher-tool/assets/global.css \
unifi-voucher-tool/assets/vendor/inter/inter.css \
unifi-voucher-tool/assets/vendor/inter/LICENSE.txt \
unifi-voucher-tool/includes/Ui.php
do
if ! grep -Fxq "$required" /tmp/zip-inhalt.txt; then
echo "Fehlt im Paket: $required" >&2
exit 1
fi
done
# Und umgekehrt: Entwicklungsdateien haben im Paket nichts verloren.
for forbidden in \
unifi-voucher-tool/tests/ \
unifi-voucher-tool/tools/ \
unifi-voucher-tool/docs/ \
unifi-voucher-tool/.github/
do
if grep -Fq "$forbidden" /tmp/zip-inhalt.txt; then
echo "Gehoert nicht ins Paket: $forbidden" >&2
exit 1
fi
done
echo "Paket vollständig ($(wc -l < /tmp/zip-inhalt.txt) Dateien)."
- name: Als Build-Artefakt sichern
uses: actions/upload-artifact@v3
continue-on-error: true # Artefakt-Speicher ist optional
with:
name: ${{ steps.meta.outputs.name }}
path: dist/*
retention-days: 30
- name: Release anlegen bzw. auffrischen
env:
# Forgejo stellt den Token automatisch bereit; FORGEJO_TOKEN
# (persönlicher Token) dient als Ausweichweg.
TOKEN: ${{ secrets.GITHUB_TOKEN || secrets.FORGEJO_TOKEN }}
API: ${{ github.server_url }}/api/v1/repos/${{ github.repository }}
TAG: ${{ steps.meta.outputs.tag }}
NAME: ${{ steps.meta.outputs.name }}
TITLE: ${{ steps.meta.outputs.title }}
PRERELEASE: ${{ steps.meta.outputs.prerelease }}
VERSION: ${{ steps.meta.outputs.version }}
SHORT_SHA: ${{ steps.meta.outputs.short_sha }}
BUILD_DATE: ${{ steps.meta.outputs.build_date }}
run: |
set -eu
if [ -z "${TOKEN:-}" ]; then
echo "Kein Token vorhanden – Release wird übersprungen." >&2
exit 0
fi
AUTH="Authorization: token ${TOKEN}"
# Zwei Fallstricke stecken in den Pipelines hier:
# - kein "head -1" hinter curl/grep: beendet sich das letzte Glied
# frueher, stirbt das erste an SIGPIPE und der Schritt bricht ab
# (pipefail).
# - "grep -m1" begrenzt auf die erste ZEILE, nicht auf den ersten
# Treffer. Die API antwortet einzeilig, deshalb erst mit tr an den
# Kommas umbrechen - sonst liefert die ID-Suche alle IDs des
# Dokuments auf einmal (Release, Autor, Anhaenge).
id_von() { tr ',' '\n' < "$1" | grep -m1 -o '"id":[0-9]*' | cut -d: -f2 || true; }
# Release-Text bewusst ohne Anfuehrungszeichen und Backslashes,
# damit er ohne jq direkt in den JSON-Body passt (\n bleibt literal).
BODY="Automatisch gebaut aus Commit ${SHORT_SHA}.\n\n"
BODY="${BODY}| | |\n|---|---|\n"
BODY="${BODY}| Version | ${VERSION} |\n"
BODY="${BODY}| Commit | ${SHORT_SHA} |\n"
BODY="${BODY}| Gebaut am | ${BUILD_DATE} |\n\n"
BODY="${BODY}**Neuinstallation:** ZIP entpacken, Dateien auf den Webserver legen, install.php aufrufen.\n\n"
BODY="${BODY}**Update einer bestehenden Installation:** config.php, uploads/ und updater/storage/ nicht ueberschreiben "
BODY="${BODY}- oder gleich den eingebauten Updater unter Administration, System-Update verwenden.\n\n"
BODY="${BODY}Pruefsumme: siehe beigelegte .sha256-Datei."
# Beim rollenden Vorab-Release zeigt der Tag auf den jeweils neuesten
# Stand von main. Der Push ist absichtlich nicht toedlich: schlaegt er
# fehl, bleibt der Tag stehen, Release und Dateien werden trotzdem
# aufgefrischt.
if [ "$TAG" = "latest-main" ]; then
git push -f origin "${GITHUB_SHA}:refs/tags/${TAG}" \
|| echo "Hinweis: Tag ${TAG} konnte nicht verschoben werden."
fi
# Gibt es das Release schon, wird es aufgefrischt statt geloescht und
# neu angelegt - Loeschen setzt Rechte voraus, die der Actions-Token
# nicht zwingend hat. Genau daran ist der Lauf zuvor gescheitert:
# "Release is has no Tag" ist die Antwort auf ein POST fuer einen Tag,
# zu dem es bereits ein Release gibt.
CODE="$(curl -s -o /tmp/release.json -w '%{http_code}' -H "$AUTH" "${API}/releases/tags/${TAG}")"
RELEASE_ID=""
if [ "$CODE" = "200" ]; then
RELEASE_ID="$(id_von /tmp/release.json)"
fi
case "${RELEASE_ID:-}" in
*[!0-9]*) RELEASE_ID="" ;;
esac
if [ -n "${RELEASE_ID:-}" ]; then
echo "Release ${RELEASE_ID} vorhanden – wird aufgefrischt."
CODE="$(curl -s -o /tmp/patch.json -w '%{http_code}' -X PATCH -H "$AUTH" \
-H 'Content-Type: application/json' \
-d "{\"tag_name\":\"${TAG}\",\"name\":\"${TITLE}\",\"body\":\"${BODY}\",\"draft\":false,\"prerelease\":${PRERELEASE}}" \
"${API}/releases/${RELEASE_ID}")"
if [ "$CODE" != "200" ]; then
echo "Release konnte nicht aufgefrischt werden (HTTP ${CODE}):" >&2
cat /tmp/patch.json >&2 || true
exit 1
fi
# Alte Anhaenge entfernen, damit am Release nur der aktuelle Stand haengt.
curl -s -H "$AUTH" "${API}/releases/${RELEASE_ID}/assets" -o /tmp/assets.json || true
for ASSET_ID in $(grep -o '"id":[0-9]*' /tmp/assets.json | cut -d: -f2 || true); do
CODE="$(curl -s -o /dev/null -w '%{http_code}' -X DELETE -H "$AUTH" \
"${API}/releases/${RELEASE_ID}/assets/${ASSET_ID}")"
echo "Alter Anhang ${ASSET_ID} entfernt (HTTP ${CODE})."
done
else
CODE="$(curl -s -o /tmp/release.json -w '%{http_code}' -X POST -H "$AUTH" \
-H 'Content-Type: application/json' \
-d "{\"tag_name\":\"${TAG}\",\"target_commitish\":\"${GITHUB_SHA}\",\"name\":\"${TITLE}\",\"body\":\"${BODY}\",\"draft\":false,\"prerelease\":${PRERELEASE}}" \
"${API}/releases")"
RELEASE_ID="$(id_von /tmp/release.json)"
case "${RELEASE_ID:-}" in
*[!0-9]*) RELEASE_ID="" ;;
esac
if [ "$CODE" != "201" ] || [ -z "${RELEASE_ID:-}" ]; then
echo "Release konnte nicht angelegt werden (HTTP ${CODE}):" >&2
cat /tmp/release.json >&2 || true
exit 1
fi
fi
for file in "dist/${NAME}.zip" "dist/${NAME}.zip.sha256"; do
# Der Dateiname steht in der Query, das "+" aus der Version muss
# deshalb kodiert werden - sonst haengt das Release die Datei mit
# einem Leerzeichen im Namen an und die .sha256 passt nicht mehr.
ASSET="$(basename "$file" | sed 's/+/%2B/g')"
CODE="$(curl -s -o /tmp/upload.json -w '%{http_code}' -X POST -H "$AUTH" \
-F "attachment=@${file}" \
"${API}/releases/${RELEASE_ID}/assets?name=${ASSET}")"
if [ "$CODE" != "201" ]; then
echo "Anhang $(basename "$file") fehlgeschlagen (HTTP ${CODE}):" >&2
cat /tmp/upload.json >&2 || true
exit 1
fi
echo "Angehängt: $(basename "$file")"
done
echo "Release ${TITLE} steht bereit: ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/releases/tag/${TAG}"