Activar compilaciones nativas mediante webhook

El Capgo se inicia normalmente desde una laptop o un trabajo de CI. pantalla de administración, CMS o portal interno a menudo desean una sola Webhook HTTPPulse un botón en su propia interfaz de usuario, y se inicia una compilación nativa firmada. Esta guía muestra el patrón estándar — una llamada HTTP autenticada delgada a su host code, que ejecuta el mismo flujo de trabajo de compilación Capgo que ya utiliza.

Nota

Notifica a la organización Capgo (Ir al panel de control → Organización → Webhooks) su direcciones URL sobre los eventos Capgo (paquetes, canales, miembros). Esta página es la dirección opuesta: su el sistema llama a una URL para iniciar una compilación Capgo.

Arquitectura

sequenceDiagram
  participant Admin as Admin dashboard
  participant Hook as Webhook endpoint
  participant CI as GitHub / GitLab
  participant Capgo as Capgo Build

  Admin->>Hook: POST /native-build (secret)
  Hook->>CI: repository_dispatch / pipeline trigger
  CI->>CI: checkout, npm ci, cap sync
  CI->>Capgo: build request
  Capgo-->>CI: signed binary / store upload

Usted No necesita Capgo para exponer un webhook público de construcción. Su CI ya tiene los secretos de firma; el único trabajo del webhook es iniciar ese trabajo de CI de manera segura.

Requisitos previos

• Un flujo de trabajo de construcción Capgo que ya funciona desde la CI UI o al recibir un push (GitHub Acciones)
• Permiso para crear un token GitHub fino-granular, token de disparador de GitLab o equivalente
• Un secreto compartido que su panel de administración enviará (cabecera o cuerpo)

Opción A — GitHub repository_dispatch (recomendado)

GitHub acepta una llamada de API autenticada que inicia un flujo que escucha por repository_dispatch. Cualquier panel que pueda POST JSON puede dispararlo.

1. Flujo que escucha por el webhook

Valida el payload antes Verifique y antes de cualquier paso que contenga secretos. Pase valores aceptados a través de salidas de trabajo / variables de entorno — nunca interpolar. client_payload directamente en run: scripts (orientación sobre inyección de scripts).

.github/trabajos/capgo-build-webhook.yml

name: Capgo Build (Webhook)

on:
  repository_dispatch:
    types: [capgo-native-build]

jobs:
  validate:
    runs-on: ubuntu-latest
    outputs:
      platform: ${{ steps.check.outputs.platform }}
      mode: ${{ steps.check.outputs.mode }}
      ref: ${{ steps.check.outputs.ref }}
      platforms_json: ${{ steps.check.outputs.platforms_json }}
    steps:
      - id: check
        env:
          RAW_PLATFORM: ${{ github.event.client_payload.platform }}
          RAW_MODE: ${{ github.event.client_payload.mode }}
          RAW_REF: ${{ github.event.client_payload.ref }}
          DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
        run: |
          PLATFORM="${RAW_PLATFORM:-android}"
          MODE="${RAW_MODE:-release}"
          REF="${RAW_REF:-$DEFAULT_BRANCH}"
          case "$PLATFORM" in ios|android|both) ;; *)
            echo "Invalid platform: $PLATFORM" >&2; exit 1;;
          esac
          case "$MODE" in debug|release) ;; *)
            echo "Invalid mode: $MODE" >&2; exit 1;;
          esac
          # Allowlist branches / tags / full SHAs only
          if [[ ! "$REF" =~ ^(main|master|production|release/[A-Za-z0-9._-]+|[0-9a-f]{40})$ ]]; then
            echo "Ref not allowlisted: $REF" >&2
            exit 1
          fi
          if [ "$PLATFORM" = "both" ]; then
            PLATFORMS_JSON='["ios","android"]'
          else
            PLATFORMS_JSON=$(printf '["%s"]' "$PLATFORM")
          fi
          {
            echo "platform=$PLATFORM"
            echo "mode=$MODE"
            echo "ref=$REF"
            echo "platforms_json=$PLATFORMS_JSON"
          } >> "$GITHUB_OUTPUT"

  build:
    needs: validate
    runs-on: ubuntu-latest
    environment: ${{ needs.validate.outputs.mode == 'release' && 'production' || 'build-debug' }}
    strategy:
      fail-fast: false
      matrix:
        platform: ${{ fromJSON(needs.validate.outputs.platforms_json) }}
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ needs.validate.outputs.ref }}

      - uses: actions/setup-node@v6
        with:
          node-version: '24'
          cache: 'npm'

      - run: npm ci
      - run: npm run build
      - name: Sync native project
        env:
          PLATFORM: ${{ matrix.platform }}
        run: npx cap sync "$PLATFORM"

      - name: Capgo Build
        env:
          CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
          BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }}
          P12_PASSWORD: ${{ secrets.P12_PASSWORD }}
          CAPGO_IOS_PROVISIONING_MAP: ${{ secrets.CAPGO_IOS_PROVISIONING_MAP }}
          APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }}
          APPLE_ISSUER_ID: ${{ secrets.APPLE_ISSUER_ID }}
          APPLE_KEY_CONTENT: ${{ secrets.APPLE_KEY_CONTENT }}
          APP_STORE_CONNECT_TEAM_ID: ${{ secrets.APP_STORE_CONNECT_TEAM_ID }}
          ANDROID_KEYSTORE_FILE: ${{ secrets.ANDROID_KEYSTORE_FILE }}
          KEYSTORE_KEY_ALIAS: ${{ secrets.KEYSTORE_KEY_ALIAS }}
          KEYSTORE_KEY_PASSWORD: ${{ secrets.KEYSTORE_KEY_PASSWORD }}
          KEYSTORE_STORE_PASSWORD: ${{ secrets.KEYSTORE_STORE_PASSWORD }}
          PLAY_CONFIG_JSON: ${{ secrets.PLAY_CONFIG_JSON }}
          PLATFORM: ${{ matrix.platform }}
          MODE: ${{ needs.validate.outputs.mode }}
        run: |
          npx @capgo/cli@latest build request com.example.app \
            --platform "$PLATFORM" \
            --build-mode "$MODE"

2. Crea un token GitHub

Crear un token de acceso personalizado (o GitHub token de instalación de la aplicación) Contenido: Leer y escribir en el repositorio (obligatorio para repository_dispatch) Almacénalo solo en tu backend de administración — nunca en el navegador.

3. Llama al webhook desde tu panel de administración

Su backend (no el navegador del usuario) debe enviar:

curl -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/dispatches \
  -d '{
    "event_type": "capgo-native-build",
    "client_payload": {
      "platform": "both",
      "mode": "release",
      "ref": "main",
      "requested_by": "admin@example.com"
    }
  }'

Campo	Propósito
event_type	Debe coincidir types en el flujo de trabajo (capgo-native-build)
client_payload.platform	ios, androido both
client_payload.mode	debug o release
client_payload.ref	Rama o etiqueta para construir (opcional)

Conecta el mismo JSON POST a un botón en tu interfaz de usuario administrativa (“Crear aplicaciones nativas”). La consola solo necesita alcanzar your backend; el backend almacena GITHUB_TOKEN.

Advertencia

Never embed el GitHub token in frontend JavaScript. La página de administración debe llamar a su servidor; su servidor llama a GitHub.

Opción B — Tiny proxy webhook (cualquier host)

Si la herramienta de administración solo puede enviar un POST a una URL que controla (Zapier, Make, Cloudflare Worker, ruta de Express), coloque un proxy corto frente a GitHub:

// Example Cloudflare Worker / Node handler (sketch)
export default {
  async fetch(request, env) {
    if (request.method !== 'POST') {
      return new Response('Method not allowed', { status: 405 })
    }
    if (request.headers.get('x-webhook-secret') !== env.WEBHOOK_SECRET) {
      return new Response('Unauthorized', { status: 401 })
    }
    const body = await request.json().catch(() => ({}))
    const platform = body.platform || 'both'
    const mode = body.mode || 'release'
    const ref = body.ref || 'main'
    if (!['ios', 'android', 'both'].includes(platform)) {
      return new Response('Invalid platform', { status: 400 })
    }
    if (!['debug', 'release'].includes(mode)) {
      return new Response('Invalid mode', { status: 400 })
    }
    if (!/^(main|master|production|release\/[A-Za-z0-9._-]+|[0-9a-f]{40})$/.test(ref)) {
      return new Response('Ref not allowlisted', { status: 400 })
    }
    const res = await fetch(
      `https://api.github.com/repos/${env.GITHUB_OWNER}/${env.GITHUB_REPO}/dispatches`,
      {
        method: 'POST',
        headers: {
          Accept: 'application/vnd.github+json',
          Authorization: `Bearer ${env.GITHUB_TOKEN}`,
          'X-GitHub-Api-Version': '2022-11-28',
        },
        body: JSON.stringify({
          event_type: 'capgo-native-build',
          client_payload: { platform, mode, ref },
        }),
      },
    )
    return new Response(res.status === 204 ? 'Build queued' : await res.text(), {
      status: res.status === 204 ? 200 : res.status,
    })
  },
}

Luego configure el producto de administración:

Configuración	Valor
URL	https://your-worker.example.com/native-build
Metodo	POST
Cabecera	x-webhook-secret: <shared secret>
Cuerpo	{ "platform": "both", "mode": "release" }

Esta es la forma habitual para conectar un webhook a un panel de administración en vivo: el panel almacena una URL y una clave secreta; Capgo credenciales permanecen en GitHub Acciones.

Trigger de Pipeline de GitLab

GitLab expone tokens de disparo de pipeline que son objetivos webhooks naturales.

# .gitlab-ci.yml fragment
capgo_native_webhook:
  stage: build
  script:
    - npm ci && npm run build
    - npx cap sync "${PLATFORM:-android}"
    - npx @capgo/cli@latest build request com.example.app --platform "${PLATFORM:-android}" --build-mode "${BUILD_MODE:-release}"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "trigger"'

Crear un token de desencadenante en Configuración → CI/CD → Tokens de disparo de pipeline, luego desde la consola de administración:

curl -X POST \
  -F token=$GITLAB_TRIGGER_TOKEN \
  -F ref=main \
  -F "variables[PLATFORM]=android" \
  -F "variables[BUILD_MODE]=release" \
  https://gitlab.com/api/v4/projects/PROJECT_ID/trigger/pipeline

Para ambas plataformas, se pueden disparar dos tramas o expandir el trabajo en una matriz paralela de la misma manera que el ejemplo GitHub.

Bitbucket y Azure

plataforma	mecanismo de webhook
Bitbucket	URL de disparo de pipeline or custom pipeline + app password POST
Azure DevOps	Ejecución de pipeline REST API con una PAT; utilice el pipeline manual desde Disparador desde la interfaz de CI

Patrón es idéntico: administrador → su clave secreta de verificación → host API → Capgo Tarea de construcción.

Payload Checklist for Admin Tools

Cuando se construye la forma del panel de control, recolecte al menos:

• Plataforma — ios / android / ambos
• Modo — depuración (QA) o de liberación (almacenamiento)
• Referencia Git — rama o etiqueta para construir
• Actor — email or user id for audit logs (pass through client_payload)

Optional: después de la ejecución, tener CI enviar de vuelta al administrador API con la URL de descarga desde --output-record / build last-output.

Seguridad

• Sección titulada “Seguridad”x-webhook-secretAutenticar cada webhook (
• Allowlist platform, modeLista blanca ref en ambos el proxy y el flujo de trabajo validate trabajo — manejar client_payload como un input no confiable.
• Transmite valores aceptados a través de variables de entorno / salidas de trabajo; no interpola campos del payload run: scripts.
• Mantén los tokens GitHub/GitLab en el lado del servidor.
• Preferir tokens con alcance en un solo repositorio.
• Limita la tasa de proxy; las compilaciones nativas cuestan minutos de compilación.
• Para enviar versiones de tienda, configura release a un entorno protegido GitHub de Entorno (como en el ejemplo) o requiere una bandera de confirmación adicional verificada en validate.

Guías relacionadas

Título de sección: "Guías relacionadas" Same Capgo Build job, started from the Actions / Pipelines tab.

GitHub Configuración de acciones Uso de credenciales exportadas y nombres de secretos por estos flujos de trabajo.

Auto OTA o Nativo Al hacer push en Git, elija live update vs nativo automáticamente.