Skip to content

Commit c66374a

Browse files
author
Aaron Chambers
committed
Merge pull request #31 from LevelbossMike/master
[BREAKING] Make `region` a required configuration.
2 parents 17c632d + b25098d commit c66374a

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,27 @@ For detailed information on how configuration of plugins works, please refer to
6262
**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)
6363
<hr/>
6464

65-
### region
65+
### accessKeyId (`required`)
6666

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

69-
__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)_
70+
### secretAccessKey (`required`)
7071

71-
*Default:* `'us-east-1'`
72+
The AWS secret for the user that has the ability to upload to the `bucket`.
73+
*Default:* `undefined`
74+
75+
### bucket (`required`)
76+
77+
The AWS bucket that the files will be uploaded to.
78+
79+
*Default:* `undefined`
80+
81+
### region (`required`)
82+
83+
The region your bucket is located in. (e.g. set this to `eu-west-1` if your bucket is located in the 'Ireland' region)
84+
85+
*Default:* `undefined`
7286

7387
### prefix
7488

index.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ module.exports = {
1313
name: options.name,
1414

1515
defaultConfig: {
16-
region: 'us-east-1',
1716
filePattern: 'index.html',
1817
prefix: '',
1918
acl: 'public-read',
@@ -29,7 +28,7 @@ module.exports = {
2928
},
3029
allowOverwrite: false
3130
},
32-
requiredConfig: ['accessKeyId', 'secretAccessKey', 'bucket'],
31+
requiredConfig: ['accessKeyId', 'secretAccessKey', 'bucket', 'region'],
3332

3433
upload: function(context) {
3534
var bucket = this.readConfig('bucket');

0 commit comments

Comments
 (0)