Intégration GitLab CI/CD

Intégrez les mises à jour en direct Capgo avec GitLab CI/CD pour déployer automatiquement vos mises à jour d'applications chaque fois que vous poussez code des modifications. Ce guide couvre la configuration des workflows de construction automatique, de test et de déploiement.

Prérequis

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

• Un compte GitLab avec un référentiel de projet
• Un Capgo compte avec une application configurée
• Node.js et npm/yarn configurés dans votre projet

Configuration de GitLab CI/CD

Étape 1 : Configurer les variables d'environnement

Tout d'abord, configurez les variables nécessaires dans votre projet GitLab :

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

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

Conseil

Obtenez votre jeton Capgo API à partir de 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é

Déployer les branches de fonctionnalité dans les canaux de test pour la revue et les tests :

# 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

Conseil

Test avec les canaux: Après le déploiement vers un canal de fonctionnalités, 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 la configuration des canaux dans votre application.

Utilisation de l'encryption

Si vous utilisez la fonctionnalité d'encryption de __CAPGO_KEEP_0__ Capgo’s encryption featureAprès

la mise en place des clés d'encryption localement, ajoutez votre clé privée aux variables GitLab : Fenêtre de terminal

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

Ajoutez ce contenu comme CAPGO_PRIVATE_KEY dans les variables de votre projet GitLab (marquez-les 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 le .capgo_key_v2 fichier à la gestion 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

Pour obtenir des informations complètes sur la configuration et la gestion de plusieurs canaux de déploiement, consultez la documentation sur les 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 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-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 la branche

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

# 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

Pratiques de Sécurité

Variables Protégées

1. Marquer les Variables Sensibles: Toujours marquer les jetons API comme protégés et masqués
2. Protection de Branches: Utiliser 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

Ajoutez 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

Configurez les notifications par e-mail dans les paramètres de votre projet GitLab ou utilisez l’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

Résolution des problèmes

Section intitulée « Problèmes courants »

Pipeline fails with “Capgo CLI not found”:

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

Copier dans le presse-papier

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

Copier dans le presse-papier

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

Débogage de la pipeline

Ajoutez 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-en plus sur Canaux pour gérer différents environnements de déploiement
• Découvrez Stockage personnalisé pour des scénarios de déploiement avancés
• Configurez Chiffrement pour des déploiements sécurisés
• Configurez Comportement de mise à jour pour personnaliser la façon dont les mises à jour sont appliquées

Avec l'intégration GitLab CI/CD, vous pouvez automatiser vos déploiements Capgo et vous assurer de mises à jour cohérentes et fiables pour vos utilisateurs d'applications mobiles.

Continuez avec l'intégration GitLab CI/CD

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