Probot

🤖 Um framework para criar aplicativos do GitHub para automatizar e melhorar seu fluxo de trabalho

Se você já pensou, "não seria legal se o GitHub pudesse..."; Eu vou parar você aí mesmo. A maioria dos recursos pode realmente ser adicionada via GitHub Apps, que estende o GitHub e pode ser instalado diretamente em organizações e contas de usuários e com acesso a repositórios específicos. Eles vêm com permissões granulares e webhooks integrados. Os aplicativos são atores de primeira classe no GitHub.

Como funciona

Probot é um framework para construir GitHub Apps em Node.js, escrito em TypeScript. O GitHub Apps pode ouvir eventos de webhook enviados por um repositório ou organização. O Probot usa seu emissor de evento interno para executar ações com base nesses eventos. Um aplicativo Probot simples pode ter esta aparência:

module.exports = (app) => {
  app.on("issues.opened", async (context) => {
    const issueComment = context.issue({
      body: "Obrigado por abrir esta issue!",
    });
    return context.octokit.issues.createComment(issueComment);
  });
};

Criando um app Probot

Se você acessou este repositório GitHub e está procurando começar a construir seu próprio aplicativo Probot, não precisa procurar mais do que probot.github.io! O site Probot contém nossa extensa documentação inicial e o guiará pelo processo de configuração.

Este repositório hospeda o código do pacote npm Probot, que é o que todos os Apps Probot executam. A maioria das pessoas que vem neste repositório provavelmente estão querendo começar construindo seu próprio aplicativo.

Contribuindo

Probot é construído por pessoas como você! A maioria das coisas interessantes são construídas com o Probot, então considere começar escrevendo um novo aplicativo ou melhorando um dos existentes.

Se você estiver interessado em contribuir com o Probot, confira nossa doc de contribuição para começar.

Quer conversar com usuários Probot e colaboradores? Junte-se a nós no Slack!

Ideias

Tem uma ideia para um novo app GitHub legal (feito com o Probot)? Isso é ótimo! Se você quer feedback, ajuda, ou apenas para compartilhá-lo com o mundo, você pode fazer isso criando uma issue no repositório probot/ideas!