Orbit
Conectar un Repositorio de GitHub
Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…
Antes de que Orbit pueda desplegar nada desde GitHub debes instalar la Kapsule Orbit GitHub App en tu cuenta de GitHub u organización y elegir qué repositorios puede ver. Esta guía te explica la instalación, la selección de un repositorio, la creación del proyecto y qué hacer cuando un repositorio que esperas no aparece.
Antes de Empezar
Necesitas permiso para instalar una GitHub App en la cuenta u organización que posee el repositorio. En una cuenta personal es automático. En una organización, o bien necesitas ser propietario, o bien un propietario necesita aprobar tu solicitud de instalación desde la configuración de la organización.
Paso 1: Instalar la Kapsule Orbit GitHub App
- En KPanel, haz clic en Orbit en la barra lateral izquierda.
- Haz clic en New project.
- Deja el modo configurado en Import Git Repo.
- En el paso 1, haz clic en Connect GitHub.
Se te envía a GitHub para instalar la app Kapsule Orbit. GitHub te pregunta dónde instalarla (tu cuenta personal u una organización) y luego si concedes acceso a All repositories o Only select repositories.
Elige Only select repositories y marca solo los repositorios que planeas desplegar. Puedes añadir más después desde GitHub sin desconectar ni recrear nada en Orbit, y mantiene pequeño el radio de impacto de la integración.
Cuando termines, GitHub te devuelve a KPanel. El paso 1 ahora muestra Just connected, y tus repositorios se cargan en el paso 2.
Paso 2: Seleccionar un Repositorio
Tus repositorios accesibles aparecen como una lista. Haz clic en Select en el que quieras desplegar. Los repositorios privados llevan una insignia Private; Orbit despliega tanto repositorios públicos como privados.
Una vez seleccionado, el repositorio muestra una insignia Selected, y un enlace Change te permite elegir uno diferente.
Si Falta un Repositorio
Orbit solo puede listar lo que la GitHub App puede ver. Si un repositorio que esperas no está ahí:
- Haz clic en Reconnect GitHub en el paso 1 para volver a ejecutar el flujo de instalación, o abre directamente github.com/settings/installations.
- Abre la instalación de Kapsule Orbit y añade el repositorio faltante bajo Repository access.
- Vuelve a KPanel. La lista se actualiza.
Si el panel muestra No repos accessible, la app está instalada pero no se le ha concedido ningún repositorio. Abre la configuración de la GitHub App y concede acceso a al menos uno.
Otras causas comunes:
- El repositorio pertenece a una organización en la que no has instalado la app. Instalarla en tu cuenta personal no cubre repositorios de organizaciones.
- Un propietario de la organización aún no ha aprobado tu solicitud de instalación. Hasta que lo haga, la app existe pero no ve nada.
- El repositorio fue transferido o renombrado después de instalar la app. Vuelve a ejecutar el flujo de instalación para actualizar lo que Orbit puede ver.
Paso 3: Configurar Tu Proyecto
Con un repositorio seleccionado, el paso 3 pide dos campos:
| Campo | Qué hace |
|---|---|
| Project Name | El nombre mostrado en KPanel, por ejemplo my-app |
| Deploy URL | El subdominio bajo kaps.run, así que my-app se convierte en my-app.kaps.run |
Haz clic en Create project. Orbit clona el repositorio, pone tu primer build en cola, y te deja en la descripción general del proyecto donde puedes ver el flujo de registros.
El slug de la Deploy URL se establece una sola vez en la creación y no puede cambiarse después. Si quieres una dirección pública diferente más tarde, adjunta un dominio personalizado en lugar de intentar renombrar el slug. Consulta Adding a Custom Domain to Your Project.
Qué Orbit Configura Automáticamente
Crear el proyecto te configura push-to-deploy automáticamente. No hay ningún webhook que configurar manualmente:
- Los pushes a tu rama de producción colean un despliegue de producción.
- Si Branch previews está habilitado, los pushes a cualquier otra rama construyen una vista previa aislada en
branch-<branch-name>.kaps.run. Consulta Branch Preview Deployments in Orbit. - La actividad de solicitudes de extracción se rastrea, así que un despliegue de vista previa muestra el número de PR al que pertenece.
- Cerrar o fusionar una solicitud de extracción pausa su vista previa, y el almacenamiento se recupera en aproximadamente un día.
Condicionando Despliegues en GitHub Actions
Si ejecutas pruebas en GitHub Actions puedes hacer que Orbit las espere. En Settings, luego CI required checks, introduce los nombres exactos de los trabajos de Actions, separados por comas, por ejemplo build,test,lint. Todas las comprobaciones nombradas deben pasar antes de que un despliegue de producción activado por push proceda. Un fallo de CI cancela el despliegue de Orbit automáticamente.
Esto se aplica solo a la rama de producción.
Reconectando o Cambiando Tu Instalación
Para cambiar qué repositorios Orbit puede ver:
- Haz clic en Orbit, luego en New project.
- En el paso 1, haz clic en Reconnect para volver a ejecutar el flujo de instalación de la GitHub App.
O gestiona la instalación directamente en github.com/settings/installations. Los cambios ahí se recogen la próxima vez que Orbit liste tus repositorios.
Desconectando GitHub
En el paso 1 de New project, haz clic en Disconnect.
Desconectar elimina el enlace entre tu cuenta de Kapsule y GitHub. Tus proyectos e historial de despliegues se mantienen, y el despliegue actualmente en vivo continúa sirviendo tráfico, pero los despliegues activados por push se detienen hasta que te reconectes. Los webhooks de despliegue siguen funcionando, porque obtienen la rama head a través de la conexión del proveedor: si la conexión se ha ido, una llamada de webhook falla con un error en lugar de desplegar código antiguo.
Lecturas Relacionadas
- Deploying Your Project para el ciclo completo de despliegue y las compuertas que lo controlan
- Configuring Your Build Command and Output Directory si el primer build falla o sirve algo incorrecto
- Connecting a GitLab Repo y Connecting a Bitbucket Repo para los otros proveedores