Intégration CI/CD GitLab

Integrate Capgo Live Updates with GitLab CI/CD to automatically deploy your app updates whenever you push code changes. This guide covers setting up automated builds, testing, and deployment workflows.

Prerequisites

Avant de configurer l'intégration de GitLab CI/CD, assurez-vous d'avoir :

• Avez-vous un compte GitLab avec un dépôt de projet
• Un compte Capgo avec une application configurée
• Node.js et npm/yarn configurés dans votre projet

Configurer GitLab CI/CD

Étape 1 : Configurer les variables d'environnement

Configurez d'abord les variables nécessaires dans votre projet GitLab :

1. Accédez à votre projet GitLab
2. Allez à Paramètres → CI/CD → Variables
3. Ajoutez les variables suivantes :

Nom de la variable	Valeur	Protégé	Masqué
CAPGO_TOKEN	Votre jeton Capgo API	✅ Oui	✅ Oui

Conseil

Obtenez votre jeton Capgo API sur console.capgo.app/apikeysVotre ID d'application est déjà configuré dans votre capacitor.config.ts fichier.

Simple

Configuration de base qui déploie en production à chaque poussée sur la branche principale :

# .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

Avancé

Déploiements de branches de fonctionnalités

Déployez les branches de fonctionnalités dans les canaux de test pour examen et test.

# 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 add $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

Conseil

Test avec les canauxAprès avoir déployé vers un canal de fonctionnalité, vous pouvez tester la mise à jour dans votre application en la configurant pour utiliser ce canal spécifique. En savoir plus sur la configuration des canaux dans votre application.

Utilisation de l'encryption

__CAPGO_KEEP_0__ Capgo's fonction de cryptageVous devrez stocker votre clé privée de manière sécurisée dans votre environnement CI/CD.

After configuration des clés de chiffrement Localement, ajoutez votre clé privée aux variables GitLab :

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

Ajoutez ce contenu en tant que CAPGO_PRIVATE_KEY dans les variables de votre projet GitLab (marquez comme protégées et masquées), puis utilisez-les dans les 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

Attention

Meilleures pratiques de sécurité :

• N'ajoutez jamais la .capgo_key_v2 fichier au contrôle de version
• Stockez la clé privée uniquement dans une gestion sécurisée de secrets CI/CD
• Utilisez des clés différentes pour différents environnements

Configuration Multi-Canal

Voir la documentation détaillée sur la configuration et la gestion de plusieurs canaux de déploiement. documentation des canaux.

Configuration complète avec plusieurs environnements et déploiements de demande de fusion :

# .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 add $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-Environnement avec Approbation Manuelle

Pour les déploiements de production nécessitant une approbation manuelle :

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

Stratégie de déploiement basée sur les branches

Déployez automatiquement différentes branches sur les canaux appropriés :

# 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

Meilleures Pratiques de Sécurité

Variables Protégées

1. Marquer les Variables Sensibles: Marquez toujours les jetons API comme protégés et masqués
2. Protection de Branches: Utilisez les variables protégées pour les déploiements de production
3. Contrôle d'accès: Limiter l'accès aux variables aux seuls administrateurs
4. Rotation régulière: Roter les jetons API régulièrement

Configuration de pipeline sécurisée

# 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"

Surveillance et notifications

Intégration Slack

Ajouter des notifications Slack à votre pipeline :

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

Notifications par e-mail

Configure email notifications in your GitLab project settings or use the 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

Troubleshooting

Problèmes courants

La pipeline échoue avec « Capgo CLI non trouvé ».

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

Erreurs d'authentification :

# 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}"

Artéfacts de construction non trouvés :

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

Pipeline de débogage

Ajouter des informations de débogage pour résoudre les problèmes :

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

Étapes suivantes

• Apprenez à Channels gérer différents environnements de déploiement
• Explore Stockage personnalisé Découvrez les scénarios de déploiement avancés
• Configurer Chiffrer Découvrez les déploiements sécurisés
• Configurer Comportement d'actualisation personnaliser l'application des mises à jour

With GitLab CI/CD integration, you can automate your Capgo deployments and ensure consistent, reliable updates to your mobile app users.

Continuez avec l'intégration GitLab CI/CD

Si vous utilisez Intégration GitLab CI/CD pour planifier l'automatisation CI/CD, connectez-l’à Capgo CI/CD pour le flux de workflow du produit dans Capgo CI/CD, Capgo Builds natifs pour le flux de workflow du produit dans Capgo Builds natifs, Capgo Intégrations pour le flux de workflow du produit dans Capgo Intégrations, Intégration CI/CD pour les détails d'implémentation dans Intégration CI/CD, et GitHub Actions Intégration pour les détails d'implémentation dans GitHub Actions d'intégration.