Go to file

Brandon Keepers b6d44f0b9b Clean up link to slack channel		2017-08-22 16:37:35 -05:00
.github	Create config.yml	2017-07-31 15:13:41 -07:00
bin	remove deprecated integration id	2017-08-05 13:45:05 -04:00
docs	it's on the same tab	2017-08-21 14:33:59 -07:00
lib	add version for deprecation to console.warn and inline comment	2017-08-22 10:10:07 -07:00
script	Update website submodule when updating docs	2017-08-18 11:13:53 -05:00
test	add test to ensure deprecation occurs	2017-08-22 10:10:27 -07: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	Update publish-docs to copy API docs to website	2017-08-18 10:55:11 -05:00
.jsdoc.json	Update publish-docs to copy API docs to website	2017-08-18 10:55:11 -05:00
.travis.yml	Remove env variables	2017-03-27 22:22:59 -05:00
CHANGELOG.md	Prepare for 0.9.1	2017-08-09 08:37:09 -05:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2017-04-06 18:49:20 -05:00
CONTRIBUTING.md	0 -> 1 silly markdown	2017-08-21 14:28:26 -07:00
LICENSE	Update LICENSE	2017-07-16 16:41:12 -07:00
README.md	Clean up link to slack channel	2017-08-22 16:37:35 -05:00
app.json	Update name from "GitHub Integrations" to "GitHub Apps"	2017-06-05 21:11:08 -05:00
index.js	Add test for event serializer and fix cause of error	2017-08-09 15:03:40 -05:00
package-lock.json	0.9.1	2017-08-09 08:37:53 -05:00
package.json	Add linter extend to package.json	2017-08-21 10:09:32 -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.

Want to chat with Probot users and contributors? Join us in the Slack channel!