Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BREAKING] Make region a required configuration. #31

Merged
merged 1 commit into from
Dec 16, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,27 @@ For detailed information on how configuration of plugins works, please refer to
**WARNING: Don't share a configuration object between [ember-cli-deploy-s3](https://github.com/ember-cli-deploy/ember-cli-deploy-s3) and this plugin. The way these two plugins read their configuration has sideeffects which will unfortunately break your deploy if you share one configuration object between the two** (we are already working on a fix)
<hr/>

### region
### accessKeyId (`required`)

The region your bucket is located in.
The AWS access key for the user that has the ability to upload to the `bucket`.
*Default:* `undefined`

__NOTE__: _You need to set the region if your bucket is not located in the default region. (e.g. set this to `eu-west-1` if your bucket is located in the 'Ireland' region)_
### secretAccessKey (`required`)

*Default:* `'us-east-1'`
The AWS secret for the user that has the ability to upload to the `bucket`.
*Default:* `undefined`

### bucket (`required`)

The AWS bucket that the files will be uploaded to.

*Default:* `undefined`

### region (`required`)

The region your bucket is located in. (e.g. set this to `eu-west-1` if your bucket is located in the 'Ireland' region)

*Default:* `undefined`

### prefix

Expand Down
3 changes: 1 addition & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ module.exports = {
name: options.name,

defaultConfig: {
region: 'us-east-1',
filePattern: 'index.html',
prefix: '',
acl: 'public-read',
Expand All @@ -29,7 +28,7 @@ module.exports = {
},
allowOverwrite: false
},
requiredConfig: ['accessKeyId', 'secretAccessKey', 'bucket'],
requiredConfig: ['accessKeyId', 'secretAccessKey', 'bucket', 'region'],

upload: function(context) {
var bucket = this.readConfig('bucket');
Expand Down