forked from mirrors/probot
34 lines
2.3 KiB
Markdown
34 lines
2.3 KiB
Markdown
# PRobot
|
|
|
|
[](https://gitter.im/bkeepers/PRobot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
_**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](https://hubot.github.com/), but for GitHub events instead of chat messages.
|
|
|
|
## Installing
|
|
|
|
_**Heads up!** The [demo integration](https://github.com/integration/probot-demo) is for demo purposes only. It is very likely to go away at some point, so please don't use it for production purposes._
|
|
|
|
0. Go to the **[demo integration](https://github.com/integration/probot-demo)**, click **Install**, and then select an organization.
|
|
0. Create a `.probot.js` file in your repository with the following contents. See [Configuration](docs/configuration.md) 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");
|
|
|
|
0. Open a new issue. @probot should post a comment (you may need to refresh to see it).
|
|
|
|
### Deploy your own bot to Heroku
|
|
|
|
0. [](https://heroku.com/deploy) - 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.
|
|
0. In another tab, [create an integration](https://developer.github.com/early-access/integrations/creating-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.
|
|
0. After creating your GitHub integration, go back to the Heroku tab and fill in the configuration variables with the values for the GitHub Integration
|
|
0. Create a `.probot.yml` file in your repository. See [Configuring](#configuring).
|