Integración con GitLab CI/CD

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.

Configuración con IA

Antes de configurar la integración de GitLab CI/CD, asegúrese de tener:

• Una cuenta de GitLab con un repositorio de proyecto
• Una cuenta de Capgo con una aplicación configurada
• Node.js y npm/yarn configurados en su proyecto

Configuración de GitLab CI/CD

Paso 1: Configurar variables de entorno

Primero, establezca las variables necesarias en su proyecto de GitLab:

1. Navegue a su proyecto de GitLab
2. Vaya a Configuración → CI/CD → Variables
3. Agregar las siguientes variables:

Nombre de la variable	Valor	Protegido	Oculto
CAPGO_TOKEN	Su token Capgo API	✅ Sí	✅ Sí

Consejo

Obtén tu token Capgo API desde console.capgo.app/apikeysTu ID de aplicación ya está configurada en tu capacitor.config.ts archivo.

Simple

Configuración básica que despliega a producción en cada push a la rama principal:

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

Avanzado

Despliegues de rama de características

Despliegue rama de funcionalidad a canales de prueba para revisión y pruebas:

# 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

Consejo

Pruebas con Canales: Después de desplegar a un canal de funcionalidad, puede probar la actualización en su aplicación configurándola para utilizar ese canal específico. Aprenda más sobre la configuración de canales en su aplicación.

Usando la Cifrado

Si está utilizando Capgo’s característica de cifrado, necesitarás almacenar tu clave privada de manera segura en tu entorno de CI/CD.

Después de configurar las claves de cifrado localmente, agrega tu clave privada a las variables de GitLab:

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

Agrega este contenido como CAPGO_PRIVATE_KEY en las variables de tu proyecto de GitLab (marca como protegidas y ocultas), luego úsalo en las 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

Cuidado

Prácticas de seguridad recomendadas:

• Nunca cometas el archivo a control de versiones .capgo_key_v2 almacena la clave privada solo en la gestión de secretos de CI/CD segura
• Utiliza claves diferentes para diferentes entornos
• Configuración de múltiples canales

Sección titulada “Configuración de múltiples canales”

documentación de canales Configuración completa con múltiples entornos y despliegues de solicitud de revisión: .

Copiar al portapapeles

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

Sección titulada “Con múltiples entornos con aprobación manual”

Para despliegues de producción que requieren aprobación manual:

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

Estrategia de Despliegue Basada en Rama

Despliegue de diferentes ramas a los canales correspondientes de manera automática:

# 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

Prácticas de Seguridad

Variables Protegidas

1. Marcar Variables Sensibles: Siempre marca los tokens API como protegidos y ocultos
2. Protección de Rama: Utilice variables protegidas para despliegues de producción
3. Control de Acceso: Limitar el acceso a variables a los mantenedores solo
4. Rotación Regular: Rotar tokens API con regularidad

Configuración de Pipeline Segura

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

Monitoreo y Notificaciones

Integración con Slack

Agregar notificaciones de Slack a tu 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

Notificaciones por correo electrónico

Configura notificaciones por correo electrónico en los ajustes de proyecto de GitLab o utiliza el 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

Solución de problemas

Problemas comunes

La pipeline falla con “Capgo CLI no encontrado”

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

Errores de autenticación:

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

No se encontraron artefactos de compilación:

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

Pipoteca de depuración

Agregar información de depuración para solucionar problemas:

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

Pasos siguientes

• Aprender sobre Canales para gestionar diferentes entornos de despliegue
• Explora Almacenamiento personalizado para escenarios de despliegue avanzados
• Configura Cifrado para despliegues seguros
• Configura Comportamiento de actualización para personalizar cómo se aplican las actualizaciones

Con la integración de GitLab CI/CD, puedes automatizar tus Capgo despliegues y asegurarte de que las actualizaciones sean consistentes y fiables para los usuarios de tu aplicación móvil.