Probot

A framework for building GitHub Apps to automate and improve your workflow

Bot
probot/probotprobot.github.ioprobot

README

Probot's logo, a cartoon robot

Probot

A framework for building GitHub Apps to automate and improve your workflow

npm Build Status Codecov @ProbotTheRobot on Twitter



If you've ever thought, "wouldn't it be cool if GitHub could…"; I'm going to stop you right there. Most features can actually be added via GitHub Apps, which extend GitHub and can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. Apps are first class actors within GitHub.

How it works


Probot is a framework for building GitHub Apps in Node.js, written in TypeScript. GitHub Apps can listen to webhook events sent by a repository or organization. Probot uses its internal event emitter to perform actions based on those events. A simple Probot App might look like this:

  1. ``` js
  2. module.exports = (app) => {
  3.   app.on("issues.opened", async (context) => {
  4.     const issueComment = context.issue({
  5.       body: "Thanks for opening this issue!",
  6.     });
  7.     return context.octokit.issues.createComment(issueComment);
  8.   });

  10.   app.onAny(async (context) => {
  11.     context.log.info({ event: context.name, action: context.payload.action });
  12.   });

  14.   app.onError(async (error) => {
  15.     app.log.error(error);
  16.   });
  17. };
  18. ```

Building a Probot App


If you've landed in this GitHub repository and are looking to start building your own Probot App, look no further than probot.github.io! The Probot website contains our extensive getting started documentation and will guide you through the set up process.

This repository hosts the code for the npm Probot package which is what all Probot Apps run on. Most folks who land in this repository are likely looking to get started building their own app.

Contributing


Probot is built by people just like you! Most of the interesting things are built _with_ Probot, so consider starting by writing a new app or improving one of the existing ones.

If you're interested in contributing to Probot itself, check out our contributing docs to get started.

Want to chat with Probot users and contributors? Join us in Slack!

Ideas


Have an idea for a cool new GitHub App (built with Probot)? That's great! If you want feedback, help, or just to share it with the world you can do so by [creating an issue in the probot/ideas repository](https://github.com/probot/ideas/issues/new)!