Integración con GitLab CI/CD

Integra Capgo Live Updates con GitLab CI/CD para desplegar automáticamente las actualizaciones de tu app cada vez que hagas push de code. Esta guía cubre la configuración de builds automatizados, testing y workflows de despliegue.

Requisitos

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

• Una cuenta de GitLab con un repositorio de proyecto
• Una cuenta de Capgo con una app configurada
• Node.js y npm/yarn configurados en tu proyecto

Configuración de GitLab CI/CD

Paso 1: Configurar variables de entorno

Primero, configura las variables necesarias en tu proyecto de GitLab:

1. Ve a tu proyecto de GitLab
2. Ve a Configuración → CI/CD → Variables
3. Añade las siguientes variables:

Nombre de la variable	Valor	Protegida	Enmascarada
CAPGO_TOKEN	Tu token de Capgo API	✅ Sí	✅ Sí

Consejo

Obtén tu token de API Capgo en console.capgo.app/apikeys. Tu app ID ya está configurado en tu capacitor.config.ts archivo.

Simple

Configuración básica que despliega a producción con cada push a la rama main:

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

Deploy de feature branches

Despliega feature branches a canales de prueba para revisión y testing:

# 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

Consejo

Pruebas con canales: Tras desplegar en un canal de feature, puedes probar la actualización en tu app configurándola para usar ese canal específico. Más información sobre cómo configurar los canales en tu app.

Uso de cifrado

Si estás usando La función de cifrado de Capgo, deberás almacenar tu clave privada de forma segura en tu entorno de CI/CD.

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

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

Añade este contenido como CAPGO_PRIVATE_KEY en las variables de tu proyecto de GitLab (márcala como protegida y enmascarada), luego úsala en tus 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

Atención

Buenas prácticas de seguridad:

• Nunca subas el .capgo_key_v2 archivo al control de versiones
• Guarda la clave privada solo en gestores de secretos de CI/CD seguros
• Usa claves distintas para cada entorno

Configuración multicanal

Para obtener información completa sobre cómo configurar y gestionar varios canales de despliegue, consulta la documentación de canales.

Configuración completa con múltiples entornos y despliegues por merge request:

# .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-entorno 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 por ramas

Despliega diferentes ramas en los canales correspondientes automáticamente:

# 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

Buenas prácticas de seguridad

Variables protegidas

1. Marcar variables sensibles: Marca siempre los tokens API como protegidos y enmascarados
2. Protección de ramas: Usa variables protegidas para despliegues en producción
3. Control de acceso: Limita el acceso a las variables solo a los maintainers
4. Rotación periódica: Rota los tokens API regularmente

Configuración segura del pipeline

# 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

Añade 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 email

Configura las notificaciones por email en los ajustes de tu proyecto de GitLab o usa 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

El pipeline falla con “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

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 encuentran los artifacts del build:

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

Pipeline de debug

Añade 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

Próximos pasos

• Aprende sobre Canales para gestionar distintos entornos de despliegue
• Explorar Almacenamiento personalizado para escenarios de despliegue avanzados
• Configurar Cifrado para despliegues seguros
• Configurar Comportamiento de actualización para personalizar cómo se aplican las actualizaciones

Con la integración de GitLab CI/CD, puedes automatizar tus despliegues de Capgo y garantizar actualizaciones consistentes y fiables para los usuarios de tu app móvil.

Continuar desde la integración de GitLab CI/CD

Si estás usando Integración con GitLab CI/CD para planificar la automatización de CI/CD, conéctala con CI/CD de Capgo para el workflow del producto en Capgo CI/CD, Native Builds de Capgo para el workflow del producto en Capgo Native Builds, Integraciones de Capgo para el workflow del producto en las integraciones de Capgo, Integración CI/CD para el detalle de implementación en la integración de CI/CD, y Integración con GitHub Actions por el detalle de implementación en la integración de GitHub Actions.