Go to file

Brandon Keepers 38bf929a92 Merge pull request #141 from probot/read-config Add helper for loading config from a repository		2017-07-27 11:09:51 -05:00
bin	Use commander for simulate command	2017-07-18 20:32:19 +02:00
docs	Add example in doc, link from best practices	2017-07-27 10:16:19 -05:00
lib	Update API response format to include data attribute	2017-07-27 10:47:41 -05:00
script	Get simulate working again	2017-05-03 11:54:28 -05:00
test	Move test helper to block where it is used	2017-07-27 10:48:45 -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	chore(CHANGELOG): 0.7.5	2017-07-13 08:18:32 -07:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2017-04-06 18:49:20 -05:00
LICENSE	Update LICENSE	2017-07-16 16:41:12 -07: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	Fix bug introduced in 0.7.3	2017-06-30 15:54:46 -05:00
package-lock.json	0.7.5	2017-07-13 08:18:37 -07:00
package.json	Merge remote-tracking branch 'origin/master' into read-config	2017-07-27 08:11:06 -05: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.