Skip to content

Commit ecba7a5

Browse files
committed
readme
Signed-off-by: Khash Sajadi <khash@cloud66.com>
1 parent 4613043 commit ecba7a5

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Trackman is a command line tool and Go library that runs multiple commands in a
44

55
## Install
66

7-
Head to [Trackman's releases](https://github.com/cloud66/trackman/releases/tag/1.0.0-pre) and install download the executable for your OS / Architecture. Your version will be updated to the latest version after the first run, so don't worry about the version you pickup first.
7+
Head to [Trackman's releases](https://github.com/cloud66/trackman/releases/latest) and install download the executable for your OS / Architecture. Your version will be updated to the latest version after the first run, so don't worry about the version you pickup first.
88

99
## Use
1010

@@ -185,16 +185,31 @@ This will switch trackman to the **dev** (development) channel and will update i
185185

186186
## Release
187187

188-
If you want to release a new version of Trackman, follow these steps:
188+
### Automatic Release
189+
190+
All commits into `master` are built, tested and released on the `edge` channel.
191+
All tags are build, tested and released on the `stable` channel and the binaries are automatically uploaded to Github.
192+
`dev` branch is not automatically built or released.
193+
194+
### Manual Release
195+
196+
If you want to release a new version of Trackman manually, follow these steps:
189197

190198
1. Start a new Release in git flow. Make sure the release name is a valid SemVer text like `1.0.0-rc1` or `2.0.4`.
191199
2. Run `./build.sh CHANNEL`, replacing `CHANNEL` with `dev` or `stable` or `edge`
192200
3. Run `./publish.sh`. This will upload the compiled binaries (previous step) to s3.
201+
4. Create a Github release from the tag and upload the binaries to it.
193202

194203
The last step assumes you have a configured **AWS CLI** installed on your machine with the right permissions to push to `downloads.cloud66.com` bucket.
195204

196205
### Rollback
197206

207+
### Automatic Rollback
208+
209+
On Builtkite, run the needed release again with `FORCE` environment variable equal to `force`.
210+
211+
### Manual Rollback
212+
198213
If you need to rollback a release, switch to the right tag and repeat the build / publish steps but run the build step with the `--force` flag:
199214

200215
```bash

0 commit comments

Comments
 (0)