Integración con CI/CD de GitLab

Integrar Capgo Actualizaciones en vivo con GitLab CI/CD para que se desplieguen automáticamente las actualizaciones de tu aplicación cada vez que envíes code cambios. Esta guía cubre la configuración de compilaciones automatizadas, pruebas y flujos de trabajo de despliegue.

Requisitos previos

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

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

Configuración de CI/CD de GitLab

Paso 1: Configura variables de entorno

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

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

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

Consejo

Obtenga su Capgo API token desde console.capgo.app/apikeys. Su ID de aplicación ya está configurada en su capacitor.config.ts archivo.

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

Configuración avanzada

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

Despliegues de rama de características

Despliegue de ramas de características a canales de prueba para revisión y pruebas:

Configuración de rama de características avanzada

# 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

Prueba con canales: Después de desplegar en un canal de características, 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á almacenar su clave privada de manera segura en su entorno de CI/CD.

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

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

Agregar este contenido como CAPGO_PRIVATE_KEY en las variables de tu proyecto de GitLab (marcar como protegido y oculto), luego utilízalo 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:

• Nunca comites la .capgo_key_v2 archivo en control de versiones
• Almacena la clave privada solo en la gestión de secretos de CI/CD segura
• Use diferentes claves para diferentes entornos

Configuración de múltiples canales

Para obtener información completa sobre la configuración y gestión de múltiples canales de despliegue, consulte la documentación de canales.

Configuración completa con múltiples entornos y despliegues de solicitudes de extracción:

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

Configuración de 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 marque 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 administradores solo
4. Rotación Regular: Rotar tokens API con frecuencia

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

Configure las notificaciones por correo electrónico en los ajustes de proyecto de GitLab o utilice 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

Resolución de problemas

Problemas comunes

El 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 construcción:

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

Pipline 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

• Aprende sobre Canales para gestionar diferentes entornos de despliegue
• Explora Almacenamiento personalizado para escenarios de implementación avanzados
• Configuración Cifrado para implementaciones seguras
• Configurar Comportamiento de actualización para personalizar cómo se aplican las actualizaciones

Con la integración de GitLab CI/CD, puede automatizar sus Capgo implementaciones y garantizar actualizaciones consistentes y fiables para los usuarios de su aplicación móvil.

Siga adelante desde la integración de GitLab CI/CD

Si está utilizando Integración GitLab CI/CD para planificar la automatización de CI/CD, conectarlo con Capgo CI/CD para el flujo de trabajo del producto en Capgo CI/CD, Capgo Compilaciones Nativas para el flujo de trabajo del producto en Capgo Compilaciones Nativas, Capgo Integraciones para el flujo de trabajo del producto en Capgo Integraciones, Integración de CI/CD para el detalle de implementación en Integración de CI/CD, y GitHub Integración de Acciones para el detalle de implementación en GitHub Integración de Acciones.