Requisitos previos
Antes de escribir código para una GitHub App, debes registrar una GitHub App. Cuando registres una GitHub App, puedes seleccionar los permisos para la aplicación. Estos permisos determinan lo que puede hacer la GitHub App. Al registrar una aplicación, también se especifican otras opciones de configuración, incluidos los eventos de webhook que deben recibir la GitHub App. Siempre puedes cambiar la configuración del registro de la GitHub App. Para más información, consulta Registro de una instancia de GitHub App y Modificación del registro de una instancia de GitHub App.
Si quieres que la GitHub App acceda a los datos del repositorio o de la organización, tienes que instalar la GitHub App. Para más información, consulta Instalación de tu propia instancia de GitHub App.
Escritura de código para una GitHub App
Para que tu GitHub App haga algo, debes escribir código para agregar funcionalidad a la GitHub App.
Para consultar tutoriales sobre cómo escribir código para una GitHub App, consulta:
- Inicio rápido para compilar aplicaciones de GitHub
- Creación de una aplicación de GitHub que responda a eventos de webhook
- Creación de un botón "Inicio de sesión con GitHub" con una aplicación de GitHub
- Creación de una CLI con una aplicación de GitHub
Puede usar las credenciales del registro de la GitHub App para realizar solicitudes autenticadas a las API de GitHub. Para más información, consulta Acerca de la autenticación con una aplicación de GitHub.
Durante el desarrollo, es probable que utilices el equipo personal o el espacio de código para ejecutar la GitHub App. Es posible que tengas que realizar algunas modificaciones en el registro de la GitHub App durante el desarrollo:
-
Si la aplicación recibe webhooks, es posible que quieras usar una dirección URL de proxy de webhook para reenviar webhooks de GitHub al equipo o al espacio de código. Deberás actualizar la configuración "Dirección URL de webhook" en el registro de la GitHub App para usar la dirección URL del proxy de webhook. Para obtener un ejemplo, consulta: Creación de una aplicación de GitHub que responda a eventos de webhook.
-
Si la aplicación utiliza el flujo de la aplicación web para autorizar a un usuario, es posible que quieras actualizar la configuración de "URL de devolución de llamada" en el registro de la GitHub App para usar una dirección URL de devolución de llamada local. Para obtener un ejemplo, consulta: Creación de un botón "Inicio de sesión con GitHub" con una aplicación de GitHub.
Pasos siguientes
Cuando escribas el código para la GitHub App, debes asegurarte de que sigues los procedimientos recomendados. Si es necesario, no olvides actualizar el registro de la GitHub App. Si la GitHub App tiene que ejecutarse en un servidor en lugar del dispositivo de un usuario, implementa la aplicación en el servidor. Por último, puedes compartir la GitHub App con otros usuarios y organizaciones.
Seguimiento de los procedimientos recomendados
Antes de implementar la GitHub App, asegúrate de seguir los procedimientos recomendados. Por ejemplo, asegúrate de que las credenciales de la GitHub App sean seguras. Para más información, consulta Procedimientos recomendados para crear una aplicación de GitHub.
Actualización del registro de la GitHub App
Si has cambiado el registro de la GitHub App para el desarrollo, asegúrate de actualizar el registro para usar valores listos para producción. Por ejemplo, si has usado una dirección URL de proxy de webhook para el desarrollo, tienes que actualizar el campo "Dirección URL de webhook" para usar la dirección URL en la que quieres que la GitHub App reciba los webhooks durante la producción.
Implementación de la GitHub App
Cuando hayas escrito el código para la GitHub App, este debe ejecutarse en algún lugar. Si la aplicación es un sitio web o una aplicación web, puede que tengas que hospedar la aplicación en un servidor como Azure App Service. Si la aplicación es una aplicación del lado cliente, podría ejecutarse en el dispositivo de un usuario.
Uso compartido de la GitHub App
Si quieres compartir la GitHub App con otros usuarios y organizaciones, tienes que hacer que la GitHub App sea pública. Para que la GitHub App se pueda detectar mejor, puedes enumerarla en GitHub Marketplace. Para obtener más información, consulta Uso compartido de la instancia de GitHub App.