Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Varache committed Aug 10, 2018
1 parent 60a3236 commit 9a9d616
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,16 +212,42 @@ setting the `algorithm` option to one of the following
* **overwrite**: Upload the new build into the bucket without removing everyting first.
* **sync**: Use `aws s3 sync` to deploy into the bucket.

### S3 Copy

```json
{
"method": "s3-copy",
"track": "internal",
"namePattern": ":project_:version-:number_:arch.:ext"
}
```

This method copies an archive to a release track. A release track is located in the same directory as an archive.
This method will not download and extract your archive, it will copy the s3 object across

#### Naming

Optionally, you can change the naming of the relased file using the namePattern option

This option will receive the following properties from the archive:
```
project
channel
version
number
arch
ext
```
And replace the keys in your name pattern

## TODO

* Additional deploy-methods
* Builds cleanup via the kart binary
* UI for remote configuration management via the kart binary
* Adding/removing projects
* UI for listing and downloading builds
* Tests using [mock-aws-s3](https://github.com/MathieuLoutre/mock-aws-s3)
* Make a Github release when pushing to certain channels
* Add --version flag

## Licence

Expand Down

0 comments on commit 9a9d616

Please sign in to comment.