Join us for office hours !

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:

  • Semantic Pull Requests - Status check that ensures your pull requests follow the Conventional Commits spec
  • OOO - Respond to @mentions with an auto-response when you are OOO
  • commitlint - Lints all commits of new or edited pull requests and sets an appropriate status check.
  • invite-contributors - Invite authors of merged pull requests to your organization

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