Skip to content

Commit 8e03dbf

Browse files
committed
couple more doc updates
1 parent 2a3c822 commit 8e03dbf

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

auto-deployment/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ repository_url: http://github.com/atmos/hubot-auto-deploy
99

1010
The goal of the auto-deployment service is to use the [GitHub Deployment API](https://developer.github.com/v3/repos/deployments/) to facilitate deployment workflows. This helps implement one portion of [GitHub Flow](https://guides.github.com/introduction/flow/).
1111

12+
It uses simple interactions around git to decide when code changes to your application should be deployed.
13+
1214
<img src="https://cloud.githubusercontent.com/assets/38/3716148/60484298-1603-11e4-8f30-30a381f5c89d.jpg" alt="github flow" />
1315

1416
There's three distinct behaviors around auto-deployment. They work like this:
@@ -49,9 +51,11 @@ Example:
4951
* GitHub creates a deployment for your successful commit status on the deployed branch.
5052
* The HerokuBeta service picks up the deployment and pushes your 'mybranch' branch out.
5153

52-
## Options
54+
## Setup
55+
56+
Auto-Deployment is available as a [github service](https://github.com/github/github-services) and is configured in your repository's admin settings under the Webhooks & Services section.
5357

54-
GitHub will handle creating the Deployments via the API, but you will still need to configure a system that does the actual deployment for you.
58+
GitHub will handle creating Deployments via the API, but you will still need to configure a system that does the actual deployment for you.
5559

5660
### Supported Deployment Systems
5761

@@ -69,8 +73,6 @@ Right now there's only two easy ways to deploy. You can use [heaven](https://git
6973
| push_on_status | When set to `1` deployments are only created on successful commit statuses. |
7074
| status_contexts | A comma delimimted list of commit status context names to verify against.<b>Unimplemented</b>|
7175

72-
These values are all available in your repository's admin settings under the Webhooks & Services section.
73-
7476
### Chat Configuration
7577

7678
The easiest way to configure auto-deployment is via Hubot. You can configure things on a per-repo basis via hubot with the [hubot-auto-deploy](https://github.com/atmos/hubot-auto-deploy) script. This saves you from having to do things like look up a GitHub API token or remember the exact syntax.

0 commit comments

Comments
 (0)