Nota: Tu App GitHub tendra acceso a cualquier repositorio que ella misma cree, aún si alguien la instala únicamente en repositorios selectos.
Instalar tu GitHub App privada en tu repositorio
Una vez que creas una GitHub App privada, puedes instalarla en uno de tuos repositorios de usuario o de organización. Para obtener más información, consulta la sección "Flujo de instalación privada".
- Selecciona tu app desde la página de configuración de GitHub Apps.
- En la barra lateral izquierda, da clic en Instalar App.
- Da clic en Instalar junto a la cuenta de usuario o de organización que contiene el repositorio correcto.
- Instala al app en todos los repositorios o selecciona los repositorios por separado.
- Una vez instalada, verás las opciones de configuración para la app en tu cuenta seleccionada. Puedes hacer cambios aquí, o repetir los pasos anteriores para instalar la app en otra cuenta.
Permitir que las personas instalen tu app pública en su repositorio
Puedes habilitar a otras personas para que instalen tu app pública si les proporcionas la URL de instalación en lugares como la página principal de tu app. Entonces puedes dirigirlos a la página principal de tu app desde la página de llegada en GitHub.
Si estás migrándote desde una App de OAuth hacia una GitHub App, puedes utilizar los parámetros de consulta para preseleccionar los repositorios y la cuenta cuando instalen esta GitHub App. Consulta la secicón "Migrar de Apps de OAuth a GitHub Apps" para aprender más.
Estos pasos asumen que has creado una App GitHub:
- Desde la Página de configuración de GitHub Apps, selecciona la app pública que quieres configurar para que los demás la instalen.
- En "URL de la Página Principal", teclea la URL de la página principal de tu app y da clic en Guardar cambios.
- GitHub proporciona una página de llegada para tu app, la cual incluye un enlace a la "URL de la Página Principal" de la misma. Para visitar la página de llegada en GitHub, copia la URL de "Enlace público" y pégala en un buscador.
- Crea una página principal para tu app que incluya la URL de instalación de la misma:
https://github.com/apps/<app name>/installations/new.
Autorizar a los usuarios durante la instalación
Puedes simplificar el proceso de autorización si lo completas durante la instalación de la app. Para hacerlo, sleecciona Solicitar la autorización del usuario (OAuth) durante la instalación al crear o modificar tu app en GitHub. Consulta la sección "Crear una GitHub App" para aprender más al respecto.
Una vez que alguien instale tu app, necesitarás obtener un token de acceso para el usuario. Consulta los pasos 2 y 3 en la sección "Indentificar la los usuarios en tu sitio" para aprender más al respecto.
Preservar el estado de una aplicación durante su instalación
Puedes proporcionar un parámetro de state en la URL de instalación de una app para preservar el estado de la página de la aplicación y regresar a las personas a ese estado después de que instalen, se autentiquen, o acepten actualizaciones de tu GitHub App. Por ejemplo, puedes utilizar el state para correlacionar una instalación para el usuario o cuenta.
Para preservar el estado, agrégalo a la URL de instalación:
https://github.com/apps/<app name>/installations/new?state=AB12t