Go to file

Brandon Keepers 3f0171d0a2 Debug		2017-03-13 16:13:21 -05:00
bin	Debug	2017-03-13 16:13:21 -05:00
docs	More updates to docs	2017-03-13 10:38:42 -05:00
lib	Add context.isBot	2017-03-13 08:02:20 -05:00
script	Rename .env.sample to .env.example	2017-03-11 08:20:02 -06:00
test	Remove unused fixtures	2017-03-11 16:04:30 -06:00
.editorconfig	Add editorconfig	2016-09-16 11:45:59 -07:00
.env.example	Rename .env.sample to .env.example	2017-03-11 08:20:02 -06:00
.gitignore	Ignore .env	2016-10-15 22:00:53 -05:00
.travis.yml	Always load dotenv	2017-03-11 09:17:15 -06:00
CONTRIBUTING.md	Rename server.js to index.js	2017-02-24 20:32:00 -06:00
LICENSE	Add appropriate LICENSE file	2016-11-22 14:20:42 -08:00
README.md	Add plugin docs	2017-03-12 10:48:09 -05:00
app.json	Remove generated field from app.json to get around chicken/egg	2016-10-12 22:19:03 -05:00
index.js	The shell of a robot	2017-03-11 15:58:36 -06:00
package.json	Update package name	2017-03-12 11:13:31 -05:00

README.md

Probot

Heads up! "PRobot" is a codename that is almost guaranteed to change.

Probot is a trainable robot that responds to activity on GitHub. It's like Hubot, but for GitHub instead of chat.

Installing

Heads up! The demo integration is for demo purposes only. It is very likely to go away at some point, so please don't use it for production purposes.

Go to the demo integration, click Install, and then select an organization.

Create a .probot.js file in your repository with the following contents. See Configuration for more information on what behaviors can be built.

 on('issues.opened').comment(`
   Hello @{{ sender.login }}. Thanks for inviting me to your project.
   Read more about [all the things I can help you with][config]. I can't
   wait to get started!

   [config]: https://github.com/bkeepers/PRobot/blob/master/docs/configuration.md
 `);

 include("bkeepers/probot:docs/demo.js");

Open a new issue. @probot should post a comment (you may need to refresh to see it).

Deploy your own bot to Heroku

- Click this button and pick an App Name that Heroku is happy with, like your-name-probot. Before you can complete this, you'll need config variables from the next step.
In another tab, create an integration on GitHub, using https://your-app-name.herokuapp.com/ as the Homepage URL, Callback URL, and Webhook URL. The permissions and events that your bot needs access to will depend on what you use it for.
After creating your GitHub integration, go back to the Heroku tab and fill in the configuration variables with the values for the GitHub Integration
Create a .probot.yml file in your repository. See Configuring.