Sobre a instalação GitHub Apps
Observação
Esse fluxo de instalação se aplica a qualquer GitHub App, seja um aplicativo de terceiros ou um aplicativo pertencente à sua empresa. Você pode instalar o aplicativo manualmente usando o link fornecido pelo proprietário do aplicativo.
Para usar um GitHub App em seus recursos, você deve instalar o aplicativo em sua organizacional ou pessoal. Você pode instalar o mesmo GitHub App em várias contas. Por exemplo, se você instalar o aplicativo em sua conta pessoa ou em algumas organizações que possui, poderá usar o aplicativo nos repositórios pessoais, nas organizações em que instalou o aplicativo e em repositórios que são propriedade dessas organizações.
Ao instalar um aplicativo, você concede a permissão do aplicativo para acessar os organizacionais e de repositório que ele solicitou. Durante o processo de instalação, GitHub informará quais permissões o GitHub App solicitou. Para obter mais informações sobre as solicitações que a API REST GitHub App pode fazer com essas permissões, consulte Permissões necessárias para aplicativos GitHub.
Ao instalar um aplicativo que solicita permissões de repositório, você também escolherá a quais repositórios conceder o GitHub App acesso.
Antes de instalar um GitHub App, você deve garantir que confie no proprietário do GitHub App. Você também deve examinar as permissões que está GitHub App solicitando e certificar-se de que está confortável concedendo essas permissões. Para obter mais informações sobre as solicitações que a API REST GitHub App pode fazer com essas permissões, consulte Permissões necessárias para aplicativos GitHub.
Não há limite na quantidade de aplicativos que você pode instalar.
Diferença entre instalação e autorização
Depois de instalar um GitHub App, você também pode ser solicitado a autorizar o aplicativo.
Ao instalar uma GitHub App em sua conta ou organização, você concede a permissão do aplicativo para acessar os recursos da organização e do repositório solicitados. Você também especifica quais repositórios o aplicativo pode acessar. Durante o processo de instalação, o GitHub App indicará quais permissões de repositório e organização você está concedendo. Para obter mais informações sobre quais permissões diferentes permitem GitHub App fazer, consulte Escolhendo permissões para um aplicativo GitHub.
Por exemplo, você pode conceder a GitHub App permissão para ler metadados do repositório e problemas de gravação e conceder o GitHub App acesso a todos os seus repositórios.
Ao autorizar um GitHub App, você concede ao aplicativo acesso à sua GitHub conta, com base nas permissões de conta solicitadas pelo aplicativo. Durante o processo de autorização, o aplicativo indicará quais recursos o aplicativo pode acessar em sua conta. Ao autorizar um GitHub App, você também concede a permissão do aplicativo para agir em seu nome.
Por exemplo, você pode conceder à GitHub App permissão para ler seus endereços de e-mail e criar gists.
Você pode instalar um GitHub App sem autorizar o aplicativo. Da mesma forma, é possível autorizar o aplicativo sem instalá-lo.
Para obter mais informações sobre como autorizar GitHub Apps, consulte Autorizando aplicativos GitHub.
Requisitos para instalação de um GitHub App
Qualquer pessoa pode instalar GitHub Apps em a sua conta pessoal.
Os proprietários da organização podem instalar GitHub Apps em sua organização.
Os administradores do repositório poderão instalar GitHub Apps na organização que possui o repositório se o aplicativo não solicitar permissões de organização nem a permissão de "administração do repositório". Ao fazer isso, eles só podem instalar o aplicativo com acesso aos repositórios que eles administram.
Membros da organização e colaboradores externos que não podem instalar um aplicativo na organização ainda podem selecionar a organização durante o processo de instalação. Em vez de instalar o aplicativo, GitHub enviará uma notificação ao proprietário da organização para solicitar que o proprietário da organização instale o aplicativo. A capacidade de fazer essas solicitações pode ser controlada usando políticas de solicitação de acesso ao aplicativo. Confira Limitando as solicitações de acesso e instalações de aplicativos OAuth e GitHub App.
A função "gerenciador de aplicativos" não dá a uma pessoa a capacidade de instalar uma GitHub App na organização. Confira Sobre Gerenciadores de Aplicativos do GitHub.
Instalando um GitHub App
Durante o processo de instalação, o proprietário do aplicativo direcionará você para uma GitHub URL para instalar o GitHub App. A URL será semelhante a http(s)://HOSTNAME/github-apps/APP-NAME/installations/new, onde APP-NAME é o nome do GitHub App.
-
Selecione o local onde você deseja instalar o GitHub App. Você pode selecionar sua conta pessoal ou uma organização da qual você é membro.
-
Caso o aplicativo exija permissões do repositório, selecione Todos os repositórios ou Somente repositórios selecionados. O aplicativo sempre terá acesso somente leitura a, pelo menos, todos os repositórios públicos.GitHub
Se o aplicativo não exigir permissões de repositório, essas opções serão omitidas.
-
Se você escolheu Apenas repositórios selecionados na etapa anterior, na lista suspensa Selecionar repositórios, escolha os repositórios que você deseja que o aplicativo acesse.
Se o aplicativo cria algum repositório, ele também terá acesso a esses repositórios automaticamente.
-
Examine as permissões que o aplicativo está solicitando. Para obter mais informações sobre as solicitações que a API REST GitHub App pode fazer com essas permissões, consulte Permissões necessárias para aplicativos GitHub.
-
Clique em Instalar, Instalar e solicitar ou Solicitar. O botão que é apresentado depende se o proprietário da sua organização deve aprovar nenhum, alguns ou todo o acesso solicitado para o aplicativo. Para obter mais informações, consulte Requisitos para instalar um GitHub App.