probot/docs
Bex Warner c5cea724a1 it's on the same tab 2017-08-21 14:33:59 -07:00
..
README.md use settings.yml 2017-08-20 08:35:04 -07:00
best-practices.md Rework docs for website 2017-08-18 07:48:49 -05:00
deployment.md Copy over formatting fix 2017-08-18 10:03:16 -05:00
development.md it's on the same tab 2017-08-21 14:33:59 -07:00
github-api.md clarify REST API 2017-08-20 08:35:53 -07:00
hello-world.md Fill out hello-world example 2017-08-18 08:08:52 -05:00
http.md Rework docs for website 2017-08-18 07:48:49 -05:00
pagination.md Rework docs for website 2017-08-18 07:48:49 -05:00
simulating-webhooks.md Rework docs for website 2017-08-18 07:48:49 -05:00
testing.md Fix urls to example apps 2017-08-18 14:50:15 -05:00
webhooks.md Fill out hello-world example 2017-08-18 08:08:52 -05:00

README.md

next permalink
docs/hello-world.md /docs/

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 drudgerylike receiving and validating webhooks, and doing authentication handstandsso 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:

  • stale - closes abandoned issues after a period of inactivity.
  • settings - syncs repository settings defined in .github/settings.yml to GitHub, enabling Pull Requests for repository settings.
  • request-info - requests more info from newly opened Pull Requests and Issues that contain either default titles or whose description is left blank.
  • Browse more examples

Ready to get started?