Esta versão do GitHub Enterprise Server foi descontinuada em 2024-03-26. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Sobre escrever código para um Aplicativo GitHub

Você precisa escrever o código para adicionar uma funcionalidade ao seu GitHub App.

Neste artigo

Pré-requisitos

Antes de escrever o código para o GitHub App, você deve registrar o GitHub App. Ao registrar o GitHub App, você seleciona as permissões específicas para o aplicativo. Essas permissões determinam o que o GitHub App pode fazer. Ao registrar o aplicativo, você também especifica outras configurações, incluindo quais eventos de webhook seu GitHub App deve receber. Você sempre pode alterar as configurações do registro do GitHub App. Para obter mais informações, confira "Registrar um Aplicativo GitHub" e "Modificar um registro do Aplicativo GitHub."

Se você quiser que o GitHub App acesse os dados do repositório e/ou da organização, será necessário instalar o GitHub App. Para obter mais informações, confira "Instalando seu próprio Aplicativo GitHub".

Escreve o código para um GitHub App

Para que o GitHub App faça algo, você precisa escrever o código para adicionar funcionalidade ao seu GitHub App.

Para obter tutoriais sobre como escrever o código para um GitHub App, confira:

Você pode usar as credenciais do registro do GitHub App para fazer solicitações autenticadas para as APIs dos GitHub. Para obter mais informações, confira "Sobre a autenticação com um GitHub App".

Durante o desenvolvimento, você provavelmente usará seu computador pessoal ou codespace para executar seu GitHub App. Talvez seja necessário fazer algumas modificações no registro do GitHub App durante o desenvolvimento:

  • Se o aplicativo receber webhooks, talvez você queira usar uma URL de proxy do webhook para encaminhar webhooks do GitHub para seu computador ou codespace. Você precisará atualizar a configuração "URL do Webhook" no registro do GitHub App para usar a URL de proxy do webhook. Para ver um exemplo, confira "Criar um Aplicativo GitHub que responde a eventos de webhook".

  • Se o aplicativo usar o fluxo de aplicativo Web para autorizar um usuário, talvez você queira atualizar a configuração "URL de retorno de chamada" no registro do GitHub App para usar uma URL de retorno de chamada local. Para ver um exemplo, confira "Criando um botão "Logon com o GitHub" com um Aplicativo GitHub".

Próximas etapas

Depois de escrever o código para o GitHub App, você deve garantir que ele siga as melhores práticas. Se necessário, lembre-se de atualizar o registro do GitHub App. Se o GitHub App precisar ser executado em um servidor, em vez do dispositivo de um usuário, implante seu aplicativo no servidor. Finalmente, você pode compartilhar o GitHub App com outros usuários e organizações.

Seguir as práticas recomendadas

Antes de implantar o GitHub App, siga as melhores práticas. Por exemplo, verifique se as credenciais dos GitHub App são seguras. Para obter mais informações, confira "Práticas recomendadas para criar um aplicativo do GitHub".

Atualize o registro do GitHub App

Se você alterou o registro de GitHub App para desenvolvimento, atualize o registro para usar valores prontos para produção. Por exemplo, se você usou uma URL de proxy do webhook para desenvolvimento, deverá atualizar o campo "URL do Webhook" para usar a URL em que deseja que o GitHub App receba webhooks durante a produção.

Implantar seu GitHub App

Depois de escrever o código para o GitHub App, o código precisará ser executado em algum lugar. Se o aplicativo for um site ou aplicativo Web, você poderá hospedar seu aplicativo em um servidor como Serviço de Aplicativo do Azure. Se o aplicativo for um aplicativo do lado do cliente, ele poderá ser executado no dispositivo do usuário.

Compartilhe seu GitHub App

Se você quiser compartilhar o GitHub App com outros usuários e organizações, deverá tornar o GitHub App público. Para obter mais informações, confira "Compartilhando seu Aplicativo GitHub".