CI/CD-Integration

Integrating Capgo into your CI/CD pipeline allows you to fully automate the process of building and deploying updates to your app. By leveraging the Capgo CLI and semantic-release, you can ensure consistent, reliable deployments and enable rapid iteration.

Vorteile der CI/CD-Integration

• Automatisierung: Keine manuellen Schritte mehr oder Raum für menschliche Fehler. Ihr gesamtes Build-, Test- und Bereitstellungsprozess kann von Anfang bis Ende automatisiert werden.

• Einhaltung von Standards: Every deployment follows the same set of steps, ensuring a predictable and repeatable process. This is especially valuable when you have multiple team members contributing code.

• Schnellere Iterationen: Mit automatisierten Bereitstellungen können Sie Updates häufiger und mit Vertrauen bereitstellen. Keine mehr Warte auf manuelle QA oder Freigabeabstimmungen.

Capgo CLI

Der Capgo CLI ist der Schlüssel zur Integration von Capgo in Ihr CI/CD-Workflow. Er bietet Befehle zum Hochladen neuer Bundle-Versionen, zum Verwalten von Kanälen und mehr.

Der wichtigste Befehl für die CI/CD-Integration ist bundle upload:

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY

Wenn Sie Verschlüsselung verwenden, sollten Sie sie aus einer dieser Quellen bereitstellen:

Mithilfe eines privaten Schlüsseldateipfads:

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-v2 PRIVATE_KEY_PATH

Mithilfe des privaten Schlüsselinhalt direkt (empfohlen für CI/CD):

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-data-v2 PRIVATE_KEY_CONTENT

Verwendung von Umgebungsvariablen (empfohlene Praxis für CI/CD):

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-data-v2 "$CAPGO_PRIVATE_KEY"

Einstellung von Umgebungsvariablen für Verschlüsselung

Für CI/CD-Umgebungen wird empfohlen, Ihren privaten Schlüssel als Umgebungsvariable zu speichern und nicht als Datei. Hier erfahren Sie, wie Sie ihn einrichten können:

1. Holen Sie sich den Inhalt Ihres privaten Schlüssels:

   cat .capgo_key_v2 | pbcopy

   Dies kopiert den Schlüsselinhalt in Ihre Zwischenablage.

2. Fügen Sie es in Ihre CI/CD-Umgebung ein:

   • GitHub Aktionen: Fügen Sie CAPGO_PRIVATE_KEY zu Ihren Repository-Secrets
   • GitLab CI: Fügen Sie es als maskierte Variable in Ihren Projekt-Einstellungen ein
   • CircleCI: Fügen Sie es als Umgebungsvariable in Ihren Projekt-Einstellungen ein
   • Jenkins: Fügen Sie es als geheimes Textkredenzial ein

3. Verwenden Sie es in Ihrer Pipeline:

   - run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

Anmerkung: Die --key-data-v2 Flag ermöglicht es Ihnen, den privaten Schlüsselinhalt direkt als Zeichenkette zu übergeben, was es perfekt für Umgebungsvariablen in CI/CD-Pipelines macht, in denen Sie keine temporären Dateien erstellen möchten.

Dieser Befehl lädt die aktuelle Webanwendung in den angegebenen Kanal hoch. Sie führen diesen Befehl typischerweise als letztes Schritt in Ihrer CI/CD-Pipeline aus, nachdem Ihre Webanwendung erfolgreich abgeschlossen wurde.

Einrichten von Capgo in Ihrer CI/CD-Pipeline

Obwohl die genauen Schritte je nach Ihrer CI/CD-Werkzeugwahl variieren, sieht die allgemeine Prozedur für die Integration von Capgo wie folgt aus:

1. Erstellen Sie einen API-Schlüssel: Melden Sie sich bei der Capgo-Oberfläche an und erstellen Sie einen neuen API-Schlüssel. Dieser Schlüssel wird zum Authentifizieren des CLI in Ihrer CI/CD-Umgebung verwendet. Halten Sie ihn geheim und geben Sie ihn nie in Ihre Repository ein!

2. Konfigurieren Sie die bundle upload Befehl: Fügen Sie einen Schritt zu Ihrer CI/CD-Konfiguration hinzu, der den bundle upload Befehl mit den entsprechenden Argumenten:

   upload.yml

   - run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }}

   \n Ersetzen Production mit dem Kanal, zu dem Sie deployen möchten, ${{ secrets.CAPGO_API_KEY }} mit der Umgebungsvariable, die Ihren API-Schlüssel enthält, und fügen Sie --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}" falls Sie Verschlüsselung verwenden.

3. Fügen Sie den upload Schritt nach Ihrem Web-Buildhinzugeben: Stellen Sie sicher, dass der upload Schritt nach dem erfolgreichen Abschluss Ihres Web-Builds kommt. Dies stellt sicher, dass Sie immer Ihre neuesten code deployen.\n Hier ist ein Beispielkonfiguration für GitHub Actions:\n

   upload.yml

   name: Deploy to Capgo
    on:
     push:
      branches: [main]
   
   jobs:
    deploy:
    runs-on: ubuntu-latest
   
    steps:
    - uses: actions/checkout@v6
    - uses: actions/setup-node@v6
     with:
      node-version: '24'
   
    - run: npm ci
    - run: npm run build
   
    - run: npm install -g @capgo/cli
    - run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

Versionsverwaltung mit Semantic-release

Die empfohlene Methode zur Verwaltung der Versionsnummer mit Capgo besteht darin, die Versionsnummer in Ihrem capacitor.config.ts Datei festzulegen, indem Sie sie von package.json:

import pkg from './package.json'

const config: CapacitorConfig = {
  // ... other config
  plugins: {
    CapacitorUpdater: {
      version: pkg.version,
    }
  }
}

Diese Methode ermöglicht Ihnen Folgendes:

1. Semantic-release (oder jede andere Werkzeug) verwenden, um die package.json Versionsnummer
2. Automatisch Ihre App mit der aktualisierten Versionsnummer erstellen
3. Die Bundle mit der korrekten Versionsnummer hochladen

Die CI/CD-Ablaufkette würde wie folgt aussehen:

- run: npm ci
- run: npx semantic-release  # Updates package.json version
- run: npm run build         # Builds with new version from capacitor.config
- run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }}

Hier ist ein Beispiel .releaserc Konfigurationsdatei für semantic-release:

{
  "branches": [
    "main",
    {
      "name": "beta",
      "prerelease": true
    }
  ],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    [
      "@semantic-release/git",
      {
        "assets": ["CHANGELOG.md", "package.json"],
        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
      }
    ]
  ]
}

Diese Konfiguration führt Folgendes aus:

1. Analytisiert die Commit-Nachrichten, um die nächste Versionsnummer zu bestimmen, basierend auf der Conventional Commits-Spezifikation.
2. Erstellt Release-Hinweise auf der Grundlage der Commits seit der letzten Veröffentlichung.
3. Aktualisiert das CHANGELOG.md Datei mit den neuen Release-Hinweisen.
4. Aktualisiert die package.json Versionsnummer, die von Ihrem capacitor.config aufgenommen wird.
5. Kommt die aktualisierte CHANGELOG.md, package.jsonund alle anderen geänderten Dateien zurück in das Repository.

Stellen Sie sicher, dass Sie semantic-release vor der Erstellung Ihrer App ausführen, damit die aktualisierte Version in Ihrer Build enthalten ist durch den __CAPGO_KEEP_0__.config. package.json Auto-bump, wenn die lokale Version bereits auf capacitor ist

Sektion mit dem Titel “Auto-bump, wenn die lokale Version bereits auf Capgo ist”

(z. B. mit semantic-release). Wenn das nicht praktikabel ist, lassen Sie den __CAPGO_KEEP_0__ den nächsten freien Semver aus dem kanalverbundenen Paket oder sonst das letzte remote App-Version wählen: package.json Terminal-Fenster package.json (for example with semantic-release). When that is not practical, let the CLI pick the next free semver from the channel’s linked bundle, or else the latest remote app version:

npx @capgo/cli@latest bundle upload --channel=production --auto-bump
npx @capgo/cli@latest bundle upload --auto-bump major
npx @capgo/cli@latest bundle upload --auto-bump minor   # default when the flag has no value
npx @capgo/cli@latest bundle upload --auto-bump patch   # alias: fix
npx @capgo/cli@latest bundle upload --auto-bump metadata
npx @capgo/cli@latest bundle upload --channel=production --auto-bump ai

--auto-bump ai uses Capgo Cloudflare Workers AI to compare local bundle files against the previous Capgo/channel delta manifest, pick major | minor | patch | metadata, and print a short reason. With no previous Capgo version, AI is skipped and the bump is Patch.

Kombinieren Sie dies nicht. --auto-bump mit --bundle / -bSiehe die bundle upload Referenz für die vollständige Liste der Optionen.

Schwierigkeitsfälle

Wenn Sie Probleme mit Ihrer CI/CD-Integration in Capgo haben, überprüfen Sie Folgendes:

• API-Schlüssel: Stellen Sie sicher, dass Ihr API-Schlüssel gültig ist und die erforderlichen Berechtigungen hat. Wenn Sie ein Umgebungsvariable verwenden, überprüfen Sie, ob es korrekt eingestellt ist.

• CLI-Version: Stellen Sie sicher, dass Sie die neueste Version von Capgo CLI verwenden. Ältere Versionen können Kompatibilitätsprobleme oder fehlende Funktionen haben.

• Build-Artikel: Bestätigen Sie, dass Ihre Web-Ausgabe die erwarteten Ausgabedateien generiert. Capgo CLI benötigt eine gültige Web-Ausgabe, um ein Bundle zu erstellen.

• Netzwerkverbindung: Überprüfen Sie, ob Ihr CI/CD-Umgebung Zugriff auf die Capgo-Server hat. Firewall- oder Proxy-Probleme können manchmal mit der Ausführung des Befehls interferieren. upload : Wenn Sie weiterhin Schwierigkeiten haben, wenden Sie sich an __CAPGO_KEEP_0__-Support, um Hilfe zu erhalten. Sie können bei der Behebung von Problemen mit Ihrer spezifischen Konfiguration unterstützen.

If you’re still having trouble, reach out to Capgo support for assistance. They can help troubleshoot any issues with your specific setup.

Abschnitt mit dem Titel "Zusammenfassung"

Integrating Capgo into your CI/CD pipeline with proper version management can greatly streamline your development workflow. By automating your deployments and versioning through the capacitor.config approach, you can ship updates faster and with more confidence.

Datei und die Aktualisierung mit semantic-release zu verwenden capacitor.config.ts file package.json bietet eine robuste und zuverlässige Bereitstellungsprozess, der Ihnen ermöglicht, sich auf das Bauen von großartigen Funktionen zu konzentrieren, anstatt sich um manuelle Release-Schritte zu kümmern.

Für weitere Details zu den Capgo CLI Befehlen und Optionen, besuchen Sie bitte die CLI-Referenz. Und für eine tiefergehende Einführung in die Konfiguration von semantic-release, sehen Sie sich bitte die semantic-release-Dokumentation.

an. Viel Erfolg beim Bereitstellen!

Fortsetzung von CI/CD-Integration

Wenn Sie CI/CD-Integration context Capgo CI/CD zur Produktworkflow in Capgo CI/CD, Capgo Native Builds zur Produktworkflow in Capgo Native Builds, Capgo Integrations zur Produktworkflow in Capgo Integrations, GitHub Actions Integration zur Implementierungsdetail in GitHub Actions Integration, und GitLab CI/CD Integration zur Implementierungsdetail in GitLab CI/CD Integration.