GitLab CI/CD-Integration

Integriere Capgo Live Updates mit GitLab CI/CD, um Ihre App-Updates automatisch zu deployen, sobald Sie code Änderungen pushen. Diese Anleitung behandelt die Einrichtung von automatischen Builds, Tests und Bereitstellungsworkflows.

Voraussetzungen

Bevor Sie die GitLab CI/CD-Integration einrichten, stellen Sie sicher, dass Sie haben:

• Ein GitLab-Konto mit einem Projektrepository
• Ein Capgo-Konto mit einer konfigurierten App
• Node.js und npm/yarn in Ihrem Projekt konfiguriert

GitLab CI/CD einrichten

Schritt 1: Umgebungsvariablen konfigurieren

Stellen Sie zunächst die notwendigen Variablen in Ihrem GitLab-Projekt ein:

1. Navigieren Sie zu Ihrem GitLab-Projekt
2. Gehe zu Einstellungen → CI/CD → Variablen
3. Fügen Sie die folgenden Variablen hinzu:

Variablenname	Wert	Geschützt	Verdeckt
CAPGO_TOKEN	Ihr Capgo API Token	✅ Ja	✅ Ja

Tipp

Erhalten Sie Ihr Capgo API Token von console.capgo.app/apikeysIhr App-ID ist bereits in Ihrem capacitor.config.ts Datei.

Einfach

Grundlegende Konfiguration, die auf jeden Push in die Hauptzweig in die Produktion deployt:

# .gitlab-ci.yml - Simple Configuration
image: node:22

stages:
  - build
  - deploy

variables:
  npm_config_cache: "$CI_PROJECT_DIR/.npm"

build:
  stage: build
  script:
    - npm ci
    - npm run test
    - npm run build
  artifacts:
    paths:
      - dist/
    expire_in: 1 hour
  only:
    - main

deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
    # For encrypted uploads, add: --key-data-v2 "$CAPGO_PRIVATE_KEY"
  dependencies:
    - build
  only:
    - main

Erweitert

Feature Branch Deployments

Deploye Feature Branches in Testkanäle für die Überprüfung und Testung:

# Feature branch deployment
deploy_feature:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - CHANNEL_NAME="feature-$(echo $CI_COMMIT_REF_NAME | sed 's/[^a-zA-Z0-9-]/-/g')"
    - npx @capgo/cli channel create $CHANNEL_NAME --apikey $CAPGO_TOKEN || true
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel $CHANNEL_NAME
  dependencies:
    - build
  only:
    - /^feature\/.*$/
  environment:
    name: feature/$CI_COMMIT_REF_NAME
    url: https://your-app.com/channels/$CHANNEL_NAME

Tipp

Testen mit Kanälen: Nach dem Bereitstellen in einem Feature-Kanal kannst du die Aktualisierung in deiner App testen, indem du sie auf diesen spezifischen Kanal konfigurierst. Erfahre mehr über die Konfiguration von Kanälen in deiner App Erfahre mehr über die Konfiguration von Kanälen in deiner App.

Mit Verschlüsselung verwenden

Wenn Sie Capgo's Verschlüsselungsfunktion verwenden, müssen Sie Ihren privaten Schlüssel sicher in Ihrem CI/CD-Umgebung speichern.

Nachdem Sie Verschlüsselungsschlüssel lokal eingerichtet haben , fügen Sie Ihren privaten Schlüssel zu den GitLab-Variablen hinzu:

# Display your private key content (copy this output)
cat .capgo_key_v2

Fügen Sie diesen Inhalt als CAPGO_PRIVATE_KEY in Ihren GitLab-Projektvariablen (als geschützt und maskiert markieren) ein und verwenden Sie ihn in Pipelines:

# Deploy with encryption
deploy_production:
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --key-data-v2 "$CAPGO_PRIVATE_KEY" --channel production

Vorsicht

Sicherheitsbest Practices:

• Kommitiere das .capgo_key_v2 Datei nie in die Versionskontrolle
• Speichere den privaten Schlüssel nur in einer sicheren CI/CD-Schlüsselverwaltung
• Verwende unterschiedliche Schlüssel für unterschiedliche Umgebungen

Multi-Channel-Konfiguration

Für umfassende Informationen zum Einrichten und Verwalten mehrerer Bereitstellungskanäle, siehe die Dokumentation zu den Kanälen.

Vollständige Konfiguration mit mehreren Umgebungen und Merge-Anforderungen für Bereitstellungen:

# .gitlab-ci.yml - Advanced Multi-Channel Configuration
image: node:22

stages:
  - build
  - deploy

variables:
  npm_config_cache: "$CI_PROJECT_DIR/.npm"

# Build stage
build:
  stage: build
  script:
    - npm ci
    - npm run test
    - npm run build
  artifacts:
    paths:
      - dist/
    expire_in: 24 hours

# Deploy to development channel
deploy_development:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel development
  dependencies:
    - build
  only:
    - develop
  environment:
    name: development

# Deploy merge requests to test channels
deploy_mr:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - CHANNEL_NAME="mr-$CI_MERGE_REQUEST_IID"
    - npx @capgo/cli channel create $CHANNEL_NAME --apikey $CAPGO_TOKEN || true
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel $CHANNEL_NAME
  dependencies:
    - build
  only:
    - merge_requests
  environment:
    name: review/$CI_MERGE_REQUEST_IID
    url: https://your-app.com/channels/mr-$CI_MERGE_REQUEST_IID
    on_stop: cleanup_mr

# Cleanup MR channels when MR is closed
cleanup_mr:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli channel delete mr-$CI_MERGE_REQUEST_IID --apikey $CAPGO_TOKEN || true
  when: manual
  environment:
    name: review/$CI_MERGE_REQUEST_IID
    action: stop
  only:
    - merge_requests

# Deploy to staging
deploy_staging:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel staging
  dependencies:
    - build
  only:
    - develop
  environment:
    name: staging

# Deploy to production
deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
  dependencies:
    - build
  only:
    - main
  environment:
    name: production

Multi-Umgebung mit manueller Genehmigung

Für Produktionsbereitstellungen, die eine manuelle Genehmigung erfordern:

deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
  dependencies:
    - build
  only:
    - main
  when: manual
  environment:
    name: production

Branchenbasierte Bereitstellungsstrategie

Bereitstellen Sie verschiedene Branchen automatisch in die entsprechenden Kanäle:

# Dynamic channel deployment based on branch
deploy:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - |
      if [ "$CI_COMMIT_REF_NAME" = "main" ]; then
        CHANNEL="production"
      elif [ "$CI_COMMIT_REF_NAME" = "develop" ]; then
        CHANNEL="staging"
      else
        CHANNEL="development"
      fi
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel $CHANNEL
  dependencies:
    - build
  environment:
    name: $CHANNEL

Sicherheitsbest Practices

Geschützte Variablen

1. Sensiblen Variablen einen Namen geben: Markiere immer API-Tokens als geschützt und maskiert
2. Zweigschutz: Verwende geschützte Variablen für Produktionsdeployments
3. Zugriffssteuerung: Beschränke die Zugriffsmöglichkeiten auf Maintainer
4. Regelmäßige Rotation: Rotiere API-Tokens regelmäßig

Sichere Pipeline-Konfiguration

# Use protected variables for production
deploy_production:
  stage: deploy
  script:
    - npm install -g @capgo/cli
    - npx @capgo/cli bundle upload --apikey $CAPGO_TOKEN --channel production
  only:
    refs:
      - main
    variables:
      - $CI_COMMIT_REF_PROTECTED == "true"

Überwachung und Benachrichtigungen

Slack-Integration

Fügen Sie Slack-Benachrichtigungen Ihrem Pipeline hinzu:

notify_success:
  stage: .post
  image: alpine:latest
  before_script:
    - apk add --no-cache curl
  script:
    - |
      curl -X POST -H 'Content-type: application/json' \
        --data '{"text":"✅ Capgo deployment successful for '"$CI_COMMIT_REF_NAME"'"}' \
        $SLACK_WEBHOOK_URL
  when: on_success

notify_failure:
  stage: .post
  image: alpine:latest
  before_script:
    - apk add --no-cache curl
  script:
    - |
      curl -X POST -H 'Content-type: application/json' \
        --data '{"text":"❌ Capgo deployment failed for '"$CI_COMMIT_REF_NAME"'"}' \
        $SLACK_WEBHOOK_URL
  when: on_failure

E-Mail-Benachrichtigungen

Konfigurieren Sie E-Mail-Benachrichtigungen in Ihren GitLab-Projekt-Einstellungen oder verwenden Sie den API:

notify_email:
  stage: .post
  script:
    - |
      curl --request POST \
        --header "PRIVATE-TOKEN: $GITLAB_API_TOKEN" \
        --form "to=team@yourcompany.com" \
        --form "subject=Capgo Deployment Status" \
        --form "body=Deployment of $CI_COMMIT_REF_NAME completed with status: $CI_JOB_STATUS" \
        "https://gitlab.com/api/v4/projects/$CI_PROJECT_ID/emails"
  when: always

Fehlersuche

Häufige Probleme

Pipeline fehlschlägt mit „Capgo CLI nicht gefunden“:

# Debug CLI installation
debug_cli:
  script:
    - npm install -g @capgo/cli
    - which capgo || echo "Capgo CLI not found"
    - npx @capgo/cli --version

Authentifizierungsfehler:

# Verify token configuration
debug_auth:
  script:
    - |
      if [ -z "$CAPGO_TOKEN" ]; then
        echo "CAPGO_TOKEN is not set"
        exit 1
      fi
      echo "Token length: ${#CAPGO_TOKEN}"

Build-Artikel nicht gefunden:

# List build outputs
debug_build:
  script:
    - ls -la dist/
    - find dist/ -type f -name "*.js" -o -name "*.html"

Debug-Pipeline

Fehlersuche hinzufügen, um Probleme zu lösen:

debug:
  stage: build
  script:
    - echo "Branch: $CI_COMMIT_REF_NAME"
    - echo "Commit: $CI_COMMIT_SHA"
    - echo "Build: $CI_PIPELINE_ID"
    - env | grep CI_ | sort
  only:
    - branches

Nächste Schritte

• Über Kanäle um verschiedene Bereitstellungsumgebungen zu verwalten
• Entdecken Benutzerdefinierte Speicherung für fortgeschrittene Bereitstellungsanforderungen
• Einrichten Verschlüsselung für sichere Bereitstellungen
• Konfigurieren Aktualisierungsverhalten anpassen um die Anwendung von Updates anzupassen

Mit der Integration von GitLab CI/CD können Sie Ihre Capgo-Deployments automatisieren und sicherstellen, dass Ihre mobilen App-Benutzer konsistente und zuverlässige Updates erhalten.

Weitermachen von GitLab CI/CD-Integration

Wenn Sie CI/CD-Automatisierung mit GitLab CI/CD-Integration planen, verbinden Sie es mit Capgo CI/CD für das Produktworkflow in Capgo CI/CD, Capgo Native Builds für den Produktworkflow in Capgo Native Builds, Capgo Integrations für den Produktworkflow in Capgo Integrations, CI/CD-Integration für die Implementierungsdetails in CI/CD-Integration, und GitHub Actions-Integration for the implementation detail in GitHub Actions Integration.