Skip to content

Commit

Permalink
Add heroku deploy button
Browse files Browse the repository at this point in the history
  • Loading branch information
bkeepers committed Jan 22, 2017
1 parent 105e73f commit 62d4ce8
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This service syncs repository settings defined in `.github/settings.yml` to GitHub. Any changes to this file on the default branch will be synced to the repository.

## Configuration

```yaml
repository:
description: name of repo that shows up on GitHub
Expand Down Expand Up @@ -56,3 +58,16 @@ protected_branches:
teams: [team1, team2]
users: [person1, person2]
```
## Usage
0. **[Go to the integration](https://github.com/integration/configurer)**, click **Install**, and then select an organization.
0. Create a `.github/settings.yml` file in your repository. See [Configuration](#configuration) for more information.
0. Any configuration changed in `.github/settings.yml` should be reflected on GitHub.

### Deploy your own bot to Heroku

0. [![Deploy](https://www.herokucdn.com/deploy/button.svg)](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 `.github/settings.yml` file in your repository. See [Configuration](#configuration) for more information.
17 changes: 17 additions & 0 deletions app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "github-configurer",
"description": "Pull Requests for GitHub repository settings",
"keywords": ["node", "github"],
"repository": "https://github.com/bkeepers/github-configurer",
"env": {
"PRIVATE_KEY": {
"description": "the private key you downloaded when creating the GitHub Integration"
},
"INTEGRATION_ID": {
"description": "the ID of your GitHub Integration"
},
"WEBHOOK_SECRET": {
"description": "the secret configured for your GitHub Integration"
}
}
}

0 comments on commit 62d4ce8

Please sign in to comment.