Address Feedback
- Soft wrapping - YAML format fix - Better S3 Docs in README - No assumptions for defaults in example config
This commit is contained in:
parent
17ef989442
commit
9eee88b9c2
3 changed files with 10 additions and 17 deletions
17
README.md
17
README.md
|
@ -28,11 +28,7 @@ jobs:
|
||||||
```
|
```
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
The `options` parameter is synonymous with the options that `aws cli` accepts for `sync`.
|
The `options` parameter is synonymous with the options that `aws cli` accepts for `sync`. Please see [S3 Sync Options](http://docs.aws.amazon.com/cli/latest/reference/s3/sync.html#options) and pay special attention to the [Use of Exclude and Include Filters](http://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters)
|
||||||
Please see
|
|
||||||
[S3 Sync Options](http://docs.aws.amazon.com/cli/latest/reference/s3/sync.html#options)
|
|
||||||
and pay special attention to the
|
|
||||||
[Use of Exclude and Include Filters](http://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters)
|
|
||||||
|
|
||||||
Given the following directory `test` we can upload _only_ the `results` subdirectory by using the `options` JSON below.
|
Given the following directory `test` we can upload _only_ the `results` subdirectory by using the `options` JSON below.
|
||||||
|
|
||||||
|
@ -45,10 +41,9 @@ test
|
||||||
└── bad.sh
|
└── bad.sh
|
||||||
```
|
```
|
||||||
```
|
```
|
||||||
options: [
|
options:
|
||||||
"--exclude: '*'",
|
- "--exclude: '*'",
|
||||||
"--include: 'results/*'"
|
- "--include: 'results/*'"
|
||||||
]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
@ -69,6 +64,8 @@ Requires [Docker](https://www.docker.com/).
|
||||||
### Tests
|
### Tests
|
||||||
1. Run `cp config.example.json config.json`.
|
1. Run `cp config.example.json config.json`.
|
||||||
1. Modify `config.json`.
|
1. Modify `config.json`.
|
||||||
* Recommended S3 setup is via `cloud.gov`'s `s3` service and a 1-off app.
|
* See [the instructions for getting your AWS credentials](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html#cli-signup).
|
||||||
|
* Recommended local S3 setup is via `cloud.gov`'s [s3 service and a Static app](https://docs.cloud.gov/apps/s3/).
|
||||||
* Exclude the `s3://` prefix/protocol for `bucket`.
|
* Exclude the `s3://` prefix/protocol for `bucket`.
|
||||||
|
|
||||||
1. Run `./test/out </full/path/to/dir>`.
|
1. Run `./test/out </full/path/to/dir>`.
|
||||||
|
|
|
@ -9,7 +9,7 @@ exec 1>&2 # redirect all output to stderr for logging
|
||||||
source=$1
|
source=$1
|
||||||
|
|
||||||
if [ -z "$source" ]; then
|
if [ -z "$source" ]; then
|
||||||
echo "usage: $0 <full/path/to/dir>"
|
echo "usage: $0 </full/path/to/dir>"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
#######################################
|
#######################################
|
||||||
|
|
|
@ -3,10 +3,6 @@
|
||||||
"access_key_id": "",
|
"access_key_id": "",
|
||||||
"secret_access_key": "",
|
"secret_access_key": "",
|
||||||
"bucket": "",
|
"bucket": "",
|
||||||
"options": [
|
"options": []
|
||||||
"--dryrun",
|
|
||||||
"--exclude '*'",
|
|
||||||
"--include 'results/*'"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue