PKR-Lab

Entwicklung

Quelle: pkr-lab/pkr-lab-docs/capulus/capulus-ios/entwicklung.md

Entwicklung

Bauen, CI und Erweiterung der iOS-App. Für den Betrieb siehe Debugging und Fehlersuche.

Code: pkr-lab/capulus-ios


Lokal bauen

brew install xcodegen
xcodegen generate                       # erzeugt HomeserverDashboard.xcodeproj und Info.plist
open HomeserverDashboard.xcodeproj      # ⌘R
# oder ohne Xcode-Oberfläche:
xcodebuild build -project HomeserverDashboard.xcodeproj -target HomeserverDashboard CODE_SIGNING_ALLOWED=NO

Quelle der Wahrheit ist project.yml. Das .xcodeproj und HomeserverDashboard/Info.plist stehen in .gitignore und werden bei jedem xcodegen generate überschrieben. Neue Quelldateien unter HomeserverDashboard/ nimmt XcodeGen automatisch auf (sources: - path: HomeserverDashboard), Info.plist und die Entitlements sind ausgenommen. Die Root-CA ist als Ressource eingetragen (Resources/homeserver-root-ca.pem).

Ein Commit-Hook prüft Conventional Commits (.githooks/commit-msg, aktivieren mit git config core.hooksPath .githooks).


Architektur

Neuen Tab oder neue Datenquelle ergänzen

  1. Modell in Models/ (Codable, tolerant).
  2. Client in Services/ mit static let shared (für *.homeserver-Hosts HomeserverHTTP.session, sonst HomeserverHTTP.publicSession).
  3. Ansicht in Views/ mit ScreenBackground, SectionCard, glassTile(), StatusDot und NoDataText aus Theme.swift, Fehlertext als rote Zeile.
  4. Tab in RootTabView.swift dem passenden Modus zuordnen.
  5. Neue Hosts oder Schlüssel in Constants.swift. Neue Geheimnisse als eigenes Konto in Constants.Keychain, in KeychainService und als weiterer KeychainSecretSection in SettingsView.
  6. Standort- oder andere Berechtigungen in project.yml unter info.properties.
  7. Seite hier ergänzen, mit Fehlertabelle.

Tests

Es gibt keine Tests. In project.yml ist scheme.testTargets leer. Am meisten würde ein Test-Target mit Codable-Tests der Modelle gegen echte Antworten von carplay-api, Open-Meteo, Pegelonline und Tankerkönig bringen (Pflichtfelder, tolerante Fallbacks). Der Build in der CI (siehe unten) ist die einzige automatische Prüfung der Übersetzbarkeit.


CI

Workflows unter .github/workflows/:

Workflow Auslöser Prüft
ci.yml PR und Push auf main Job build (macOS): brew install xcodegen, xcodegen generate, xcodebuild build … CODE_SIGNING_ALLOWED=NO. Job ca-checksum: Resources/homeserver-root-ca.pem ist byte-identisch mit pki/homeserver-root-ca.pem in capulus-core (main). Job gitleaks: Secret-Scan über die ganze Historie (.gitleaks.toml)
codeql.yml PR, Push, wöchentlich Montag 03:41 UTC CodeQL für swift (Autobuild nach xcodegen generate) und actions
commitlint.yml PR Conventional Commits, wiederverwendbarer Workflow
release.yml Push auf main semantic-release über den zentralen Workflow, siehe Releases

Renovate (renovate.json) läuft montags, pinnt GitHub-Actions auf Digests und wartet drei Tage nach Veröffentlichung (minimumReleaseAge). Die Rolle von Renovate im Gesamtsystem: Renovate, CodeQL und Dependabot: CodeQL und Dependabot.

Fehlerbilder in der CI

Symptom Ursache Lösung
ca-checksum rot Root-CA in capulus-core geändert oder Kopie veraltet Datei kopieren: cp <capulus-core>/pki/homeserver-root-ca.pem Resources/
build rot, xcodegen meldet Konfigurationsfehler Syntaxfehler in project.yml lokal xcodegen generate ausführen
build rot mit Swift-Compilerfehler Code lokal mit xcodebuild nachstellen
gitleaks rot Geheimnis im Diff oder in der Historie entfernen und ggf. Token rotieren (Secrets-Rotation); echte Platzhalter in .gitleaks.toml freigeben
commitlint rot Commit-Nachricht nicht im Format Nachricht ändern (<typ>(<scope>): <beschreibung>)

Release

Die Marketing-Version setzt das Build-Skript „Version aus Git-Tag“ aus dem letzten Release-Tag, MARKETING_VERSION in project.yml ist nur der Rückfallwert. Eine signierte .ipa entsteht nicht in der CI. Der Build für TestFlight läuft lokal in Xcode. Siehe Releases.