Requisitos previos
Antes de escribir código para un GitHub App, debe registrar un GitHub App. Al registrar un GitHub App, se seleccionan los permisos de la aplicación. Estos permisos dictan lo que GitHub App puede hacer. Al registrar una aplicación, también se especifican otras opciones de configuración, incluidos los eventos de webhook que GitHub App debe recibir. Puede cambiar en cualquier momento la configuración de su registro de GitHub App. Para más información, consulta Registro de una aplicación de GitHub y Modificación de un registro de aplicación de GitHub.
Si desea que su GitHub App acceda a los datos del repositorio o de la organización, debe instalar su GitHub App. Para más información, consulta Instalación de su propia aplicación de GitHub.
Escribir código para un GitHub App
Para que GitHub App haga algo, debe escribir código para agregar funcionalidad a GitHub App.
Para consultar tutoriales sobre cómo escribir código para un GitHub App, consulte:
- 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 "Iniciar sesión con GitHub" con una aplicación GitHub
- Creación de una CLI con una aplicación de GitHub
Puede usar las credenciales de su registro en 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 tu ordenador personal o tu codespace para ejecutar tu GitHub App. Puede que necesite hacer algunas modificaciones en su registro GitHub App durante el desarrollo:
-
Si tu aplicación recibe webhooks, es posible que quieras usar una URL de proxy de webhook para reenviar webhooks de GitHub a tu ordenador o a Codespace. Deberá actualizar la configuración "Dirección URL de webhook" en el GitHub App registro 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 su aplicación usa el flujo de aplicación web para autorizar a un usuario, puede que quiera actualizar la configuración de la «URL de devolución de llamada» en el registro GitHub App para usar una URL de devolución de llamada local. Para obtener un ejemplo, consulta Creación de un botón "Iniciar sesión con GitHub" con una aplicación GitHub.
Pasos siguientes
Una vez que escribas el código para GitHub App, debes asegurarte de que siga las buenas prácticas. Si es necesario, recuerde actualizar el GitHub App registro. Si GitHub App debe ejecutarse en un servidor en lugar de en el dispositivo de un usuario, implemente su aplicación en su servidor. Por último, puede compartir su GitHub App con otros usuarios y organizaciones.
Seguimiento de los procedimientos recomendados
Antes de implementar GitHub App, asegúrese de seguir los procedimientos recomendados. Por ejemplo, asegúrese de que las credenciales de su GitHub App sean seguras. Para más información, consulta Procedimientos recomendados para crear una aplicación de GitHub.
Actualiza tu GitHub App registro
Si ha cambiado el GitHub App registro para el desarrollo, asegúrese de actualizar el registro para usar valores listos para producción. Por ejemplo, si utilizó una URL de proxy para webhooks en desarrollo, debe actualizar el campo "Webhook URL" para usar la URL en la que quiera que su GitHub App reciba webhooks en producción.
Despliega tu GitHub App
Una vez que haya escrito el código para GitHub App, el código debe ejecutarse en algún lugar. Si la aplicación es un sitio web o una aplicación web, es posible que hospede 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.
Comparta su GitHub App
Si quiere compartir su GitHub App con otros usuarios y organizaciones, debe hacer público su GitHub App. Para que su GitHub App sea más fácil de encontrar, puede incluirlo en GitHub Marketplace. Para obtener más información, consulte Compartir tu aplicación de GitHub.