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
- Reines SwiftUI, keine Drittbibliotheken, kein Swift Package.
- MVVM light: Ansichten beobachten
DashboardViewModel.sharedundPowerViewModel.shared(Singleton,@MainActor,ObservableObject). Ansichten des Alltag-Modus halten ihren Zustand selbst in@Stateund rufen die Clients direkt. - Clients sind einfache Klassen mit
async/awaitund je einer geteilten Instanz (.shared). Die gemeinsame Netzwerk-Basis steht inUtilities/HTTPSupport.swift(HomeserverHTTP):sessionmitMTLSDelegatefürcarplay-apiund den WoL-Agent,publicSessionfür Wetter, Pegel, Tankerkönig und News (beide mitConstants.requestTimeout), der Continuation-Wrapper umdataTask, die Statusprüfung (200 bis 299) und das Token aus dem Keychain (fehlt es:APIError.missingToken). - Modelle sind
Codableund decodieren tolerant (Standardwerte für fehlende Listen, Rückfallwerte für unbekannte Enum-Strings). - Adressen und feste Werte stehen zentral in
Utilities/Constants.swift.
Neuen Tab oder neue Datenquelle ergänzen
- Modell in
Models/(Codable, tolerant). - Client in
Services/mitstatic let shared(für*.homeserver-HostsHomeserverHTTP.session, sonstHomeserverHTTP.publicSession). - Ansicht in
Views/mitScreenBackground,SectionCard,glassTile(),StatusDotundNoDataTextausTheme.swift, Fehlertext als rote Zeile. - Tab in
RootTabView.swiftdem passenden Modus zuordnen. - Neue Hosts oder Schlüssel in
Constants.swift. Neue Geheimnisse als eigenes Konto inConstants.Keychain, inKeychainServiceund als weitererKeychainSecretSectioninSettingsView. - Standort- oder andere Berechtigungen in
project.ymlunterinfo.properties. - 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.