Was macht apply?
Wendet LaunchDarkly SDK-Onboarding an: Abhängigkeit (oder duales SDK-Paar) installieren, Umgebung und Secrets nach Zustimmung konfigurieren, Initialisierung an Einstiegspunkten hinzufügen und die Kompilierung überprüfen. Verschachtelt unter sdk-install; nächster Schritt ist run.
Übersicht
Dieses Skill automatisiert die Erstkonfiguration des LaunchDarkly SDK in Ihrem Projekt. Es führt folgende Schritte aus:
- Abhängigkeitsinstallation: Installiert das passende LaunchDarkly SDK-Paket. Für Feature-Flags wird das Server-SDK verwendet. Für dynamische Konfigurationsnutzung (Dynamic Config) wird das duale SDK-Paar (Server + Client) installiert.
- Umgebungskonfiguration: Richtet Umgebungsvariablen und Secrets ein, z. B. den SDK-Key (
LAUNCHDARKLY_SDK_KEY), nach expliziter Zustimmung des Benutzers. - Initialisierung: Fügt die SDK-Initialisierung an den Haupteinstiegspunkten der Anwendung hinzu (z. B.
main()-Funktion, App-Konstruktor, Middleware). - Kompilierungsprüfung: Überprüft, ob das Projekt nach der Installation und Konfiguration fehlerfrei kompiliert oder läuft.
Unterstützte Plattformen
Dieses Skill funktioniert mit den folgenden Sprachen/Umgebungen:
- Python (LaunchDarkly Server-SDK)
- Node.js (LaunchDarkly Server- und Client-SDKs)
- Java (LaunchDarkly Server-SDK)
- Go (LaunchDarkly Server-SDK)
- Ruby (LaunchDarkly Server-SDK)
Voraussetzungen
- Das Projekt muss bereits initialisiert sein (z. B.
package.jsonfür Node.js,requirements.txtfür Python). - Ein gültiger LaunchDarkly SDK-Key muss verfügbar sein (wird vom Benutzer bereitgestellt).
- Für Dynamic Config muss der Benutzer bestätigen, dass er ein duales SDK-Paar installieren möchte.
Verwendung
Dieses Skill wird typischerweise im Rahmen eines Workflows ausgeführt, der mit sdk-install beginnt und dann apply aufruft. Nach erfolgreicher Ausführung geht es zu run.
Beispielaufruf (kommandozeilenbasiert)
# Führen Sie das Skill in Ihrem Projektverzeichnis aus
apply-launchdarkly-sdk --language python --token "IhrSDKKey"
In einem CI/CD-Workflow
- name: LaunchDarkly SDK Onboarding
run: |
apply-launchdarkly-sdk --language node --token "${{ secrets.LAUNCHDARKLY_SDK_KEY }}"
Ablauf
- Einwilligung einholen: Der Benutzer wird gefragt, ob er LaunchDarkly SDK-Onboarding durchführen möchte. Nur nach Zustimmung wird fortgefahren.
- SDK-Typ erkennen: Anhand des Projekts und der Benutzereingabe wird ermittelt, ob ein einzelnes Server-SDK oder ein duales SDK-Paar benötigt wird.
- Abhängigkeit installieren: Das entsprechende Paket wird zu den Projektabhängigkeiten hinzugefügt.
- Umgebung und Secrets konfigurieren: Der SDK-Key wird als Umgebungsvariable oder Secret gespeichert.
- Initialisierung hinzufügen: SDK-Code wird an den Haupteinstiegspunkten eingefügt.
- Kompilierung überprüfen: Das Projekt wird kompiliert oder gestartet, um Fehler zu erkennen.
- Nächster Schritt: Nach Erfolg wird
runaufgerufen, um die Beispielimplementierung auszuführen.
Fehlerbehandlung
- Falls die Kompilierung fehlschlägt, wird eine klare Fehlermeldung mit den genauen Stellen ausgegeben.
- Wenn der Benutzer die Zustimmung verweigert, wird das Skill abgebrochen, ohne Änderungen vorzunehmen.
- Bei ungültigem SDK-Key oder Netzwerkproblemen wird eine entsprechende Meldung ausgegeben und der Vorgang gestoppt.