Introduction

If you've ever thought, "wouldn't it be cool if GitHub could…"; imma 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.

Probot is a framework for building GitHub Apps in Node.js. It aims to eliminate all the drudgery–like receiving and validating webhooks, and doing authentication handstands–so you can focus on the features you want to build.

Probot apps are easy to write, deploy, and share. Many of the most popular Probot apps are hosted, so there's nothing for you to deploy and manage. Here are just a few examples of things that have been built with Probot:

  • All Contributors - Easily recognize all contributions per the all-contributors spec
  • ApproveMan - Approves pull requests with safe changes for protected branches.
  • Auto Assign - Add reviewers/assignees to pull requests when pull requests are opened.
  • Auto-comment - Comments on new issues and pull requests based on your configuration.
  • Autoapproval - Approve pull requests using configurations
  • Background Check - Notifies maintainers when new contributors who have been toxic in the past join the project

Check out the featured apps or browse more examples on GitHub

Ready to get started?

Found a mistake or want to help improve this documentation? Suggest changes on GitHub

Get occasional updates on new apps & features.

Star

with by the Probot community

Code licensed ISC Docs licensed CC-BY-4.0