Go to file

Brandon Keepers b4cdeabfbd 0.7.0		2017-06-15 16:41:55 -07:00
bin	Test localtunnel and retry if it failed	2017-06-11 01:06:53 -05:00
docs	Merge event and context arguments	2017-06-11 17:31:47 -05:00
lib	Merge pull request #158 from probot/merge-event-context	2017-06-13 20:08:50 -07:00
script	Script to publish docs	2017-04-29 11:05:18 -05:00
test	Merge event and context arguments	2017-06-11 17:31:47 -05:00
.editorconfig	Add editorconfig	2016-09-16 11:45:59 -07:00
.env.example	Update name from "GitHub Integrations" to "GitHub Apps"	2017-06-05 21:11:08 -05:00
.gitignore	Merge remote-tracking branch 'origin/master' into jsdoc	2017-04-29 09:29:01 -05:00
.jsdoc.json	Use plugin docs as readme	2017-04-29 10:26:47 -05:00
.travis.yml	Remove env variables	2017-03-27 22:22:59 -05:00
CHANGELOG.md	Update Changelog for v0.7.0	2017-06-15 16:41:36 -07:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2017-04-06 18:49:20 -05:00
LICENSE	Add appropriate LICENSE file	2016-11-22 14:20:42 -08:00
README.md	Update name from "GitHub Integrations" to "GitHub Apps"	2017-06-05 21:11:08 -05:00
app.json	Update name from "GitHub Integrations" to "GitHub Apps"	2017-06-05 21:11:08 -05:00
index.js	Add serializer for `repository` object	2017-06-09 17:17:01 -05:00
package-lock.json	0.7.0	2017-06-15 16:41:55 -07:00
package.json	0.7.0	2017-06-15 16:41:55 -07:00

README.md

Probot

Probot is a bot framework for GitHub. It's like Hubot, but for GitHub instead of chat.

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.

There are some great services that offer apps in the GitHub Marketplace, and you can build a bunch of really cool things yourself. Probot aims to make that easy.

Plugins

Bots are implemented as plugins, which are easy to write, deploy, and share. Here are just a few examples of things probot can do:

stale - closes abandoned issues after a period of inactivity.
owners - @mentions people in Pull Requests based on contents of the OWNERS file
configurer - syncs repository settings defined in .github/config.yml to GitHub, enabling Pull Requests for repository settings.

Check out all probot plugins.

Contributing

Most of the interesting things are built with plugins, so consider starting by writing a new plugin or improving one of the existing ones.