Vertra + GitHub Actions

De tu push al próximo deploy.

Tu código ya está en GitHub. Añade la Action oficial al workflow y actualiza tu aplicación en Vertra como parte de tu flujo de desarrollo.

Configurar mi workflow Ver en GitHub

01
Push a main
git push
02
Checkout del repositorio
actions/checkout
03
Envío a Vertra
vertracloud/github-action
04
Reinicio de la aplicación
restart: true

Tu repositorio · Tu workflow · Tu aplicación.github/workflows/deploy.yml

Listo para el próximo push

Un workflow. Una tarea manual menos.

Guarda este archivo en el repositorio para enviar el proyecto con cada push a main. La aplicación debe estar creada en Vertra antes del primer deploy.

.github/workflows/deploy.yml

name: Deploy
on:
  push:
    branches: [main]
permissions:
  contents: read
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: vertracloud/github-action@v1
        with:
          api-key: ${{ secrets.VERTRA_API_KEY }}
          app-id: ${{ secrets.VERTRA_APP_ID }}

Añade VERTRA_API_KEY y VERTRA_APP_ID en Settings → Secrets and variables → Actions de tu repositorio. Nunca pongas la clave directamente en el archivo.

api-key: Obligatorio. Clave de API guardada en un GitHub Secret.
app-id: Obligatorio. ID de la aplicación existente que recibirá los archivos.
path: Opcional. Directorio del proyecto. Por defecto, la raíz del repositorio (.).
restart: Opcional. Reinicia después del envío. Por defecto, "true".

Al ritmo de tu proyecto

Tú eliges cuándo publicar.

Incorpora el deploy a las etapas que ya forman parte de tu desarrollo.

Después de tus pruebas

Añade la etapa de deploy después de las pruebas y del build de tu workflow, para enviar solo cuando las etapas anteriores terminen correctamente.

También en monorepos

Usa path para enviar solo el directorio de la aplicación, como apps/api, sin empaquetar todo el repositorio.

Credenciales en secrets

Autentícate con una clave de API guardada en GitHub Secrets. Los permisos siguen bajo tu control.

Archivos y reinicio

La Action empaqueta el proyecto, respeta .vertraignore y .vertracloudignore y permite elegir si la aplicación se reinicia después del envío.

Configuración inicial

Tres pasos. Después, sigue tu flujo.

Prepara la aplicación

Crea la aplicación en Vertra, copia su ID y genera una clave de API con los permisos necesarios para enviar archivos y reiniciar.

Añade los secrets

En el repositorio, guarda la clave en VERTRA_API_KEY y el ID en VERTRA_APP_ID, en los secrets de GitHub Actions.

Añade el workflow

Crea .github/workflows/deploy.yml con el ejemplo anterior. Haz un push a main y sigue la ejecución en la pestaña Actions.

FAQ

Antes de automatizar.

¿La Action crea una aplicación nueva?

No. Actualiza los archivos de una aplicación existente, identificada por app-id. Crea la aplicación en el panel antes de ejecutar el workflow.

¿Puedo cambiar el evento que inicia el deploy?

Sí. El ejemplo usa push a main, pero puedes configurar los eventos de GitHub Actions según tu proceso, como tags o ejecución manual.

¿Qué pasa con los archivos antiguos?

Los archivos enviados sobrescriben las rutas coincidentes. Los archivos que ya existen y no están en el envío permanecen; el deploy no los elimina.

¿Puedo enviar sin reiniciar?

Sí. Define restart como "false". El valor predeterminado es "true", que reinicia la aplicación después del envío. Siguen vigentes los límites de carga y del plan.