Skip to content

Commit a2eb66c

Browse files
committed
a bit more documentation
1 parent 12ba902 commit a2eb66c

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

auto-deployment/index.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ On GitHub everything revolves around repositories. In a lot of cases these repos
1313

1414
* Push changes to the application when the default branch is pushed to.
1515
* Push changes to the application when the default branch passes ci tests.
16-
* Continuously push branch deploys when new commits are added and tests pass.<b>Unimplemented</b>
16+
* Continuously push branch deploys when new commits are added and tests pass.
1717

1818
The goal of the auto-deployment service is to use the [GitHub Deployment API](https://developer.github.com/v3/repos/deployments/) to facilitate workflows regardless of how you're getting your code out to update your applications. This decouples the workflows from the act of delivering the code.
1919

@@ -24,26 +24,32 @@ Right now there's only two easy ways to deploy. You can use [heaven](https://git
2424
* HerokuBeta GitHub Service
2525
* Webhooks
2626

27+
### Configuration
28+
29+
| Attributes | |
30+
|------------------|-------------------------------------------------|
31+
| github_token | A GitHub [personal oauth token]() with `repo:deployment` scope |
32+
| environments | A comma delimited list of environments to deploy to automatically. |
33+
| push_on_status | When set to `1` deployments are only created on successful commit statuses. |
34+
| status_contexts | A comma delimimted list of commit status context names to verify against.<b>Unimplemented</b>|
35+
36+
These values are all available in your repository's admin settings under the Webhooks & Services section.
37+
2738
### Chat Configuration
2839

29-
You can configure things on a per-repo basis via chat with the [hubot-auto-deploy](https://github.com/atmos/hubot-auto-deploy) script. This saves you from having to constantly look up a GitHub API token. Hubot will configure the auto-deploy integration for you from chat.
40+
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.
3041

3142
## Deploy on Push
3243

3344
<img src="https://cloud.githubusercontent.com/assets/704696/3698478/df9d14ee-13c2-11e4-9f76-7b5a0da624da.jpg" alt="service list" />
3445

3546
Upon receiving a push to the default branch, GitHub emits a deployment event for that sha. This is great for workflows like "push to heroku" to see your changes live in 30-60 seconds.
3647

37-
3848
## Deploy on Commit Status
3949

4050
<img src="https://cloud.githubusercontent.com/assets/704696/3698492/3942dc04-13c3-11e4-9737-f2b69b5f49bb.jpg" alt="auto deployment ui" />
4151

42-
Upon receiving a [commit status](https://developer.github.com/v3/repos/statuses/) to the default branch, GitHub emits a deployment event if the build was successful.
43-
44-
## Deployment
45-
46-
This is all managed on your GitHub instance through the Settings section for your repo. You simply provide a GitHub personal access token with the `repo:deployment` scope.
52+
Upon receiving a [commit status](https://developer.github.com/v3/repos/statuses/) to the default branch, GitHub emits a deployment event if the commit status is successful.
4753

4854
## TODO
4955

0 commit comments

Comments
 (0)