Sobre as modificações do GitHub App
Você pode modificar o registro do GitHub App para alterar qualquer uma das configurações que foram selecionadas quando o aplicativo foi registrado inicialmente. Para obter mais informações sobre as configurações que você pode selecionar ao registrar um GitHub App, confira "Registrar um Aplicativo GitHub".
Por exemplo, você pode alterar o nome e a descrição de seu aplicativo, as permissões concedidas a ele, os webhooks aos quais seu aplicativo se inscreve ou a visibilidade do aplicativo.
Você também pode escolher testar novos recursos opcionais para seu GitHub App. Para obter mais informações, confira "Ativando recursos opcionais para aplicativos do GitHub".
Navegar até as configurações do GitHub App
Para modificar um GitHub App, primeiro navegue até a página de configurações do aplicativo.
- No canto superior direito de qualquer página do GitHub, clique na foto do seu perfil.
- Acesse as configurações da sua conta.
- Para um aplicativo de propriedade de uma conta pessoal, clique em Configurações.
- Para um aplicativo de propriedade de uma organização:
- Clique em Suas organizações.
- À direita da organização, clique em Configurações.
- Na barra lateral esquerda, clique em Configurações do desenvolvedor.
- Na barra lateral esquerda, clique em GitHub Apps .
- À direita do GitHub App que você deseja modificar, clique em Editar.
Alterar as informações básicas de um GitHub App
Você pode alterar as informações básicas do seu GitHub App, como o nome do aplicativo, a descrição do aplicativo e a URL da página inicial do aplicativo.
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Em "Informações básicas", modifique as informações de GitHub App que você gostaria de alterar.
- Clique em Salvar alterações.
Solicitar a autorização do usuário (OAuth) durante a instalação
Você pode solicitar aos usuários que autorizem o GitHub App ao instalá-lo e gerar um token de acesso do usuário. Ao solicitar a autorização do usuário (OAuth) durante a instalação, você também deve fornecer uma URL de retorno de chamada em que o usuário será redirecionado após autorizar a instalação. Para obter mais informações, confira "Como gerar um token de acesso do usuário para um GitHub App".
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Em "Identificar e autorizar usuários", selecione ou desmarque Solicitar autorização de usuário (OAuth) durante a instalação.
- Em "URL de retorno de chamada", digite a URL completa para redirecionamento após um usuário autorizar a instalação.
Habilitar ou desabilitar o fluxo do dispositivo
Você pode usar o fluxo do dispositivo para autorizar usuários para um aplicativo sem cabeçalho, como uma ferramenta CLI ou gerenciador de credenciais Git. Para saber mais sobre como usar o fluxo do dispositivo com o GitHub Apps, confira "Como gerar um token de acesso do usuário para um GitHub App".
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Em "Identificar e autorizar usuários", selecione ou desmarque Habilitar Fluxo de Dispositivo.
Adicionar ou atualizar uma URL de instalação
Você pode redirecionar as pessoas para uma URL específica depois que elas instalarem seu aplicativo. Para obter mais informações, confira "Registrar um Aplicativo GitHub".
Se você selecionou Solicitar autorização de usuário (OAuth) durante a instalação em uma etapa anterior, não é possível inserir uma URL aqui. Em vez disso, os usuários serão redirecionados para a URL de retorno de chamada como parte do fluxo de autorização, no qual você poderá descrever a configuração adicional. Para obter mais informações, confira "Sobre a URL de retorno de chamada de autorização do usuário".
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Em "Pós-instalação", no campo "URL de instalação", insira a URL para a qual você gostaria de redirecionar os usuários depois que eles instalarem o aplicativo.
- Opcionalmente, se você quiser redirecionar os usuários para a URL de instalação depois que eles atualizarem uma instalação, selecione Redirecionar após atualização. Uma atualização inclui a adição ou a remoção de um repositório para uma instalação. Se a opção "URL de Instalação" estiver em branco, isso será ignorado.
Alterar as permissões de um GitHub App
Você pode alterar as permissões de acesso concedidas ao GitHub App usando as etapas a seguir.
Quando você altera as permissões do repositório ou da organização de um aplicativo, cada conta em que o aplicativo está instalado precisará aprovar as novas permissões. Quando você alterar as permissões de conta de um aplicativo, cada usuário que autorizou o aplicativo precisará aprovar as alterações de permissão. Em ambos os casos, GitHub enviará um email para cada proprietário ou usuário da organização, notificando-os sobre a solicitação para atualizar as permissões de aplicativo. As permissões atualizadas não entrarão em vigor em uma instalação ou autorização do usuário até que as novas permissões sejam aprovadas. Você pode usar o webhook de instalação para ficar a par quando as pessoas aceitarem novas permissões para seu aplicativo.
Alterar as permissões de um aplicativo também pode alterar os webhooks nos quais seu aplicativo pode se inscrever e as ações que seu aplicativo pode executar com a API. Para obter mais informações, confira "Escolhendo permissões para um Aplicativo GitHub".
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Na barra lateral de configurações do GitHub Apps, clique em Permissões e eventos.
- Nas seções "Permissões do repositório", "Permissões da organização" e "Permissões da conta", modifique as permissões que você gostaria de alterar. Para cada tipo de permissão, selecione "Somente leitura", "Leitura e gravação" ou "Sem acesso" no menu suspenso. Para obter mais informações, confira "Escolhendo permissões para um Aplicativo GitHub".
- Opcionalmente, em "Adicionar uma observação para os usuários", adicione uma observação informando aos usuários o por que você esta mudando as permissões que o seu GitHub App solicita.
- Clique em Salvar alterações.
Ativar ou desativar o webhook do GitHub App
Você pode configurar seu GitHub App para receber webhooks para eventos específicos no GitHub e tomar medidas automaticamente sobre eles. Para obter mais informações, confira "Usar webhooks com aplicativos GitHub".
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Em "Webhook", para habilitar ou desabilitar o webhook, selecione ou desmarque Ativo.
- Se você selecionou Ativo na etapa anterior, em "URL do webhook", insira a URL para a qual o GitHub deve enviar os eventos de webhook.
- Opcionalmente, se você selecionou Ativo na etapa anterior, em "Segredo do webhook", insira um token secreto para proteger seus webhooks. O GitHub recomenda fortemente que você defina um segredo de webhook.
Alterar as assinaturas de eventos de webhook de um GitHub App
Você pode alterar os eventos de webhook aos quais um GitHub App assina usando as etapas a seguir.
Os eventos de webhook específicos que você pode selecionar no registro do GitHub App são determinados pelo tipo de permissões selecionado para seu aplicativo. Primeiro, você precisará selecionar as permissões que deseja que seu aplicativo tenha e depois assinar o aplicativo em eventos de webhook relacionados a esse conjunto de permissões. Para obter mais informações, confira "Usar webhooks com aplicativos GitHub."
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Ative o webhook do GitHub App. Para obter mais informações, confira "Como ativar ou desativar o webhook do GitHub App neste artigo.
- Na barra lateral de configurações do GitHub Apps, clique em Permissões e eventos.
- Nas seções "Permissões do repositório", "Permissões da organização" e "Permissões da conta", selecione as permissões necessárias para os eventos aos quais seu aplicativo se inscreverá. Para obter mais informações, confira "Alterar as permissões de um GitHub App".
- Em "Inscrever-se em eventos", selecione os eventos de webhook que você deseja que o GitHub App receba.
- Clique em Salvar alterações.
Alterar a visibilidade de um GitHub App
Você pode alterar as configurações de visibilidade do GitHub App para controlar quem pode instalá-lo. Aplicativos públicos não podem se tornar privados se estiverem instalados em outras contas. Para obter mais informações, confira "Tornar um aplicativo do GitHub público ou privado".
- Navegue até a página de configurações do aplicativo que você deseja modificar. Para obter mais informações, confira "Navegar até as configurações do GitHub App " neste artigo.
- Na barra lateral esquerda, clique em Avançado.
- Em "Zona de perigo", dependendo da visibilidade atual de seus dados do GitHub App, clique em Tornar público ou Tornar privado.