Repository files navigation

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

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 viaGitHub 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.

Probot is a framework for buildingGitHub Apps inNode.js, written inTypeScript. 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:

exportdefault(app)=>{app.on("issues.opened",async(context)=>{constissueComment=context.issue({body:"Thanks for opening this issue!",});returncontext.octokit.issues.createComment(issueComment);});app.onAny(async(context)=>{context.log.info({event:context.name,action:context.payload.action});});app.onError(async(error)=>{app.log.error(error);});};

If you've landed in this GitHub repository and are looking to start building your own Probot App, look no further thanprobot.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 startedbuilding their own app.

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

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

Want to discuss with Probot users and contributors?Discuss on GitHub!

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 bycreating an issue in theprobot/ideas repository!