Skip to content

Commit a6f8d09

Browse files
committed
Update readme
1 parent bdc77cd commit a6f8d09

1 file changed

Lines changed: 47 additions & 3 deletions

File tree

README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# Deployer
22

3-
Deploy dokku application using GitHub Deployments
3+
Deploy [dokku](http://dokku.viewdocs.io/dokku/) applications using [GitHub Deployments](https://developer.github.com/v3/repos/deployments/).
44

5-
1. Listen to new GitHub deployments
5+
1. Listen/poll new GitHub deployments
66
2. Create pending GitHub deployment status and empty Gist
77
3. Deploy application to dokku
88
4. Create success/failure Github deployment status and update Gist
9-
5. Sleep
9+
5. Sleep 30 seconds
1010
6. Go to step #1
1111

1212
Make sure to run `deployer` as `dokku` user.
1313

14+
To register github deployments you can use [deploy](https://github.com/remind101/deploy),
15+
[slashdeploy](https://github.com/remind101/slashdeploy) or something else.
16+
17+
If you are using Slack, you can enable 'Deploy Events -> Show deployment statuses'
18+
to get slack notifications with links to Gist.
19+
1420
## Usage
1521

1622
```bash
@@ -34,6 +40,44 @@ deployer -h
3440
GitHub username (required)
3541
```
3642

43+
## Example
44+
45+
Trigger deployment from developer's machine:
46+
47+
```bash
48+
$ cd ~/src/myapp
49+
$ deploy --branch v49.3 --env demo
50+
```
51+
52+
On the dokku server:
53+
54+
```bash
55+
$ deployer -u ghuser -p ghpass -org mak-it -repo myapp -env demo -app myapp-demo -sleep 30
56+
```
57+
58+
Output:
59+
60+
```
61+
Deployer
62+
ghuser ghpass mak-it myapp demo myapp-demo
63+
Sleep duration: 30s
64+
2017/08/24 13:31:43 Cloning repo
65+
2017/08/24 13:31:51 Adding repo dokku remote .myapp-demo myapp-demo
66+
2017/08/24 13:32:52 Getting deployment demo
67+
2017/08/24 13:32:53 Problem in getting deployment Deployment statuses already present
68+
2017/08/24 13:32:53 Sleeping 30s
69+
2017/08/24 13:33:23 Getting deployment demo
70+
2017/08/24 13:33:23 123 master demo
71+
2017/08/24 13:33:23 Fetchin repo .myapp-demo
72+
2017/08/24 13:33:24 Gist create ID: 123, Ref: v49.3, Environment: demo
73+
2017/08/24 13:33:25 Gist https://gist.github.com/...
74+
2017/08/24 13:33:25 Deployment status create pending
75+
2017/08/24 13:33:26 Deploying repo .myapp-demo
76+
Everything up-to-date
77+
2017/08/24 13:33:26 Deployment status create success
78+
2017/08/24 13:33:26 Gist update
79+
```
80+
3781
## Build
3882

3983
```bash

0 commit comments

Comments
 (0)