xxq250
/
probot
forked from mirrors/probot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
522 Commits 12 Branches 306 Tags 38 MiB
TypeScript 97%
JavaScript 2.4%
Shell 0.6%
Go to file
Lee Dohm 24ef94f232
Add tests for .getPluginConfig 		2017-05-13 20:19:22 -07:00
bin Find private key if it is not set 2017-04-29 07:50:59 -05:00
docs Update plugins.md 2017-05-04 11:17:26 -05:00
lib 👕 2017-05-12 09:04:09 -07:00
script Script to publish docs 2017-04-29 11:05:18 -05:00
test Add tests for .getPluginConfig 2017-05-13 20:19:22 -07:00
.editorconfig Add editorconfig 2016-09-16 11:45:59 -07:00
.env.example Add subdomain option 2017-04-08 17:09:03 -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
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 a 2017-03-27 15:06:04 -05:00
app.json Update all the docs 2017-03-13 22:26:59 -05:00
index.js Log unhandled rejections 2017-04-29 07:56:12 -05:00
package.json 👕 2017-05-12 09:04:09 -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 Integrations:

Integrations are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. Integrations are first class actors within GitHub.

–Documentation on GitHub Integrations

There are some great services that offer hosted integrations, but 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.