Sobre como escrever código para um aplicativo GitHub

Pré-requisitos

Antes de escrever o código para um GitHub App, você deve registrar um GitHub App. Ao registrar um GitHub App, você seleciona permissões para o aplicativo. Essas permissões determinam o que pode GitHub App fazer. Ao registrar um aplicativo, você também especifica outras configurações, incluindo quais eventos de webhook você GitHub App deve receber. Você sempre pode alterar as configurações do registro GitHub App . Para saber mais, confira Registrando um aplicativo GitHub e Modificando um registro de aplicativo GitHub.

Se você quiser que seu GitHub App acesse dados de repositórios e/ou da organização, será necessário instalar seu GitHub App. Para saber mais, confira Instalando seu próprio aplicativo GitHub.

Escrevendo código para um GitHub App

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

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

Você pode usar as credenciais de seu GitHub App registro para fazer solicitações autenticadas para GitHubAPIs. Para saber mais, confira Sobre a autenticação com um aplicativo GitHub.

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 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" em seu GitHub App registro para usar a URL do proxy do webhook. Para ver um exemplo, confira Criando um aplicativo GitHub que responde a eventos de webhook.
Se o seu aplicativo usa 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 seu GitHub App para usar uma URL de retorno de chamada local. Para ver um exemplo, confira Criando um botão "Logon com GitHub" com um aplicativo GitHub.

Próximas etapas

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

Seguir as práticas recomendadas

Antes de implantar seu/sua GitHub App, certifique-se de seguir as práticas recomendadas. Por exemplo, verifique se suas GitHub Appcredenciais estão seguras. Para saber mais, confira Práticas recomendadas para criar um aplicativo GitHub.

Atualizar seu GitHub App registro

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

Implante seu GitHub App

Depois de escrever o código do seu GitHub App, esse código precisa ser executado em algum lugar. Se seu 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 seu GitHub App com outros usuários e organizações, você deverá tornar seu GitHub App público. Para obter mais informações, consulte Compartilhando seu Aplicativo GitHub.

Neste artigo