Conectar GitHub
Conecta tu repositorio de GitHub a Jamdesk para despliegues automáticos en cada push. Cubre instalación de la app, selección de repositorio y rama.
Jamdesk se integra con GitHub para desplegar automáticamente tu documentación cuando haces push con cambios.
Las capturas de pantalla muestran la interfaz en inglés.
Para más información sobre cómo funcionan juntos la GitHub App y el enlace de cuenta personal, consulta Comprender la integración con GitHub.
Instalación de la GitHub App
Cuando inicias sesión en Jamdesk por primera vez, se te pedirá que instales la Jamdesk GitHub App. Esta app permite:
- Acceso al repositorio - Leer el contenido de tu documentación
- Webhooks - Activar builds en cada push
- Estado del commit - Mostrar el estado del build en los commits
Permisos
La Jamdesk GitHub App solicita estos permisos:
| Permiso | Propósito |
|---|---|
| Contenido del repositorio (lectura) | Clonar y leer tus archivos de documentación |
| Metadatos (lectura) | Listar repositorios y ramas |
| Webhooks | Recibir notificaciones de push |
Jamdesk solo accede a los repositorios a los que explícitamente le otorgas acceso. Puedes modificar el acceso en cualquier momento en tu configuración de GitHub.
Conectar un repositorio
Al crear o editar un proyecto, haz clic en Conectar repositorio.
Elige entre los repositorios donde la GitHub App está instalada.
Selecciona la rama a desplegar:
- main o master - La más común para documentación en producción
- docs - Si mantienes la documentación en una rama separada
- Cualquier rama - Para despliegues de preview
Si tu docs.json no está en la raíz del repositorio, especifica la ruta:
docs/ # Docs in a subdirectory
packages/docs/ # Monorepo with docs packageDéjalo en blanco si docs.json está en la raíz.
Una vez conectado, el dashboard de tu proyecto muestra el repositorio y la rama vinculados:
Despliegues automáticos
Una vez conectado, cada push a tu rama configurada activa un build:
git add .
git commit -m "Update API documentation"
git push origin mainLos builds suelen completarse en 30-90 segundos. Consulta el estado en el dashboard o en el commit de GitHub.
Cambiar de repositorio
Para conectar un repositorio diferente:
- Ve a Configuración → Repositorio
- Haz clic en Cambiar repositorio
- Selecciona el nuevo repositorio y la rama
Cambiar de repositorio puede afectar tu documentación en producción. El nuevo repositorio debe contener una configuración válida de Jamdesk.
Gestionar el acceso a la GitHub App
Controla a qué repositorios puede acceder Jamdesk:
- Ve a github.com/settings/installations
- Encuentra Jamdesk en la lista
- Haz clic en Configurar
- En "Acceso al repositorio", selecciona repositorios específicos o todos
Repositorios de organizaciones
Para repositorios de organizaciones, un administrador de la organización debe aprobar la instalación de la GitHub App:
- Solicita la instalación desde tu dashboard de Jamdesk
- Un administrador recibe una notificación en GitHub
- Una vez aprobado, los repositorios de la organización aparecen en el selector de repositorios
Vincular tu cuenta personal
Para una atribución de builds confiable, vincula tu cuenta personal de GitHub en Configuración de usuario:
- Haz clic en tu avatar → Configuración de usuario
- Busca la sección Cuenta de GitHub
- Haz clic en Vincular cuenta de GitHub
Esto es independiente de la GitHub App y garantiza que tus commits te sean correctamente atribuidos. Más información.
Solución de problemas
El repositorio no aparece
- Verifica que la GitHub App esté instalada en el repositorio
- Para repositorios de organizaciones, confirma que un administrador haya aprobado el acceso
- Intenta actualizar la lista de repositorios en el dashboard
Los builds no se activan
- Comprueba que el webhook esté activo en la configuración del repositorio
- Verifica que estés haciendo push a la rama configurada
- Busca errores en la entrega de webhooks en GitHub
Errores de permiso denegado
- Vuelve a autorizar la GitHub App en tu configuración de GitHub
- Asegúrate de que el repositorio sea accesible para la Jamdesk App
Para una solución de problemas más detallada, consulta Comprender la integración con GitHub.