Skip to content
This repository has been archived by the owner on Dec 9, 2022. It is now read-only.

LOG-1772: Canoe: productionise Paddle #2

Merged
merged 12 commits into from
Oct 16, 2017
Merged

LOG-1772: Canoe: productionise Paddle #2

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
595d01b
Improves README
Sep 13, 2017
8bf1d6b
Refactor of get
Sep 25, 2017
48fd3a6
Refactor struct to its own file
Sep 25, 2017
61c25ae
Better S3 interface + tests
Sep 25, 2017
dbd350c
Couple of refactors to commit operation
Sep 26, 2017
3309911
Remove redudant return
Oct 11, 2017
b4e255d
FilesToKeys as a function
Oct 13, 2017
422e487
Simplify hasher with just a random generated string
Oct 13, 2017
16ac408
Small improvement
Oct 13, 2017
a358f62
Better readme
Oct 16, 2017
b2f065e
Release instructions
Oct 16, 2017
2f696d0
Fixes typo
Oct 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ You will need create a `$HOME/.paddle.yaml` that contains the bucket name, e.g:
bucket: roo-bucket
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth pointing out that these settings can be configured through ENV as well (e.g. BUCKET).

```

or if you prefer specific `BUCKET` as an environment variable
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "specify"


You will also need to create a `$HOME/.aws/config` or `$HOME/.aws/credentials` so Paddle can connect to AWS, e.g.:

```
Expand All @@ -31,11 +33,20 @@ aws_secret_access_key=yyy
region=eu-west-1
```

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unnecessary newline


```
$ go build
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should specify that Go must be installed only for development / tests. for actual usage, we'll be generating a binary which we can include instructions in the Readme for.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


## Release

In order to release a new version, set up github export GITHUB_TOKEN=[YOUR_TOKEN] and do the following steps:

```
$ git tag -a vX.X.X -m "[Comment]"
$ git push origin vX.X.X
$ goreleaser
```

## Usage

```
Expand Down