gulp-awspublish
Advanced tools
Comparing version 4.0.0 to 4.0.1
{ | ||
"name": "gulp-awspublish", | ||
"version": "4.0.0", | ||
"version": "4.0.1", | ||
"description": "gulp plugin to publish files to amazon s3", | ||
@@ -30,3 +30,3 @@ "keywords": [ | ||
"dependencies": { | ||
"ansi-colors": "^3.2.3", | ||
"ansi-colors": "^4.1.1", | ||
"aws-sdk": "^2.389.0", | ||
@@ -39,4 +39,4 @@ "clone": "^2.1.2", | ||
"plugin-error": "^1.0.1", | ||
"pumpify": "^1.3.5", | ||
"through2": "3.0.0", | ||
"pumpify": "^2.0.1", | ||
"through2": "^3.0.1", | ||
"vinyl": "^2.2.0", | ||
@@ -43,0 +43,0 @@ "xml-nodes": "^0.1.5", |
110
README.md
# gulp-awspublish | ||
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url] | ||
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url] [![Install size][packagephobia-image]][packagephobia-url] | ||
@@ -67,39 +67,43 @@ > awspublish plugin for [gulp](https://github.com/wearefractal/gulp) | ||
* Note: If you follow the [aws-sdk suggestions](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html) for | ||
- Note: If you follow the [aws-sdk suggestions](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html) for | ||
providing your credentials you don't need to pass them in to create the publisher. | ||
* Note: In order for publish to work on S3, your policy has to allow the following S3 actions: | ||
- Note: In order for publish to work on S3, your policy has to allow the following S3 actions: | ||
``` | ||
```json | ||
{ | ||
"Version": "2012-10-17", | ||
"Statement": [ | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"s3:ListBucket" | ||
], | ||
"Resource": [ | ||
"arn:aws:s3:::BUCKETNAME" | ||
] | ||
}, | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"s3:PutObject", | ||
"s3:PutObjectAcl", | ||
"s3:GetObject", | ||
"s3:GetObjectAcl", | ||
"s3:DeleteObject", | ||
"s3:ListMultipartUploadParts", | ||
"s3:AbortMultipartUpload" | ||
], | ||
"Resource": [ | ||
"arn:aws:s3:::BUCKETNAME/*" | ||
] | ||
} | ||
] | ||
"Version": "2012-10-17", | ||
"Statement": [ | ||
{ | ||
"Effect": "Allow", | ||
"Action": ["s3:ListBucket"], | ||
"Resource": ["arn:aws:s3:::BUCKETNAME"] | ||
}, | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"s3:PutObject", | ||
"s3:PutObjectAcl", | ||
"s3:GetObject", | ||
"s3:GetObjectAcl", | ||
"s3:DeleteObject", | ||
"s3:ListMultipartUploadParts", | ||
"s3:AbortMultipartUpload" | ||
], | ||
"Resource": ["arn:aws:s3:::BUCKETNAME/*"] | ||
} | ||
] | ||
} | ||
``` | ||
### Bucket permissions | ||
If you are receiving "Access Denied" message, verify that public access to the bucket is **not blocked**. The following permissions are known to be working: | ||
- Block all public access: **Off** | ||
- Block public access to buckets and objects granted through new access control lists (ACLs): Off | ||
- Block public access to buckets and objects granted through any access control lists (ACLs): Off | ||
- Block public access to buckets and objects granted through new public bucket policies: Off | ||
- Block public and cross-account access to buckets and objects through any public bucket policies: Off | ||
## Testing | ||
@@ -132,9 +136,9 @@ | ||
* Note: Node version 0.12.x or later is required in order to use `awspublish.gzip`. If you need an older node engine to work with gzipping, you can use [v2.0.2](https://github.com/pgherveou/gulp-awspublish/tree/v2.0.2). | ||
- Note: Node version 0.12.x or later is required in order to use `awspublish.gzip`. If you need an older node engine to work with gzipping, you can use [v2.0.2](https://github.com/pgherveou/gulp-awspublish/tree/v2.0.2). | ||
Available options: | ||
* ext: file extension to add to gzipped file (eg: { ext: '.gz' }) | ||
* smaller: gzip files only when result is smaller | ||
* Any options that can be passed to [zlib.gzip](https://nodejs.org/api/zlib.html#zlib_options) | ||
- ext: file extension to add to gzipped file (eg: { ext: '.gz' }) | ||
- smaller: gzip files only when result is smaller | ||
- Any options that can be passed to [zlib.gzip](https://nodejs.org/api/zlib.html#zlib_options) | ||
@@ -192,19 +196,19 @@ ### awspublish.create(AWSConfig, cacheOptions) | ||
* header: hash of headers to add or override to existing s3 headers. | ||
* options: optional additional publishing options | ||
* force: bypass cache / skip | ||
* noAcl: do not set x-amz-acl by default | ||
* simulate: debugging option to simulate s3 upload | ||
* createOnly: skip file updates | ||
- header: hash of headers to add or override to existing s3 headers. | ||
- options: optional additional publishing options | ||
- force: bypass cache / skip | ||
- noAcl: do not set x-amz-acl by default | ||
- simulate: debugging option to simulate s3 upload | ||
- createOnly: skip file updates | ||
Files that go through the stream receive extra properties: | ||
* s3.path: s3 path | ||
* s3.etag: file etag | ||
* s3.date: file last modified date | ||
* s3.state: publication state (create, update, delete, cache or skip) | ||
* s3.headers: s3 headers for this file. Defaults headers are: | ||
* x-amz-acl: public-read | ||
* Content-Type | ||
* Content-Length | ||
- s3.path: s3 path | ||
- s3.etag: file etag | ||
- s3.date: file last modified date | ||
- s3.state: publication state (create, update, delete, cache or skip) | ||
- s3.headers: s3 headers for this file. Defaults headers are: | ||
- x-amz-acl: public-read | ||
- Content-Type | ||
- Content-Length | ||
@@ -224,4 +228,4 @@ > Note: `publish` will never delete files remotely. To clean up unused remote files use `sync`. | ||
* prefix: prefix to sync a specific directory | ||
* whitelistedFiles: array that can contain regular expressions or strings that match against filenames that | ||
- prefix: prefix to sync a specific directory | ||
- whitelistedFiles: array that can contain regular expressions or strings that match against filenames that | ||
should never be deleted from the bucket. | ||
@@ -268,3 +272,3 @@ | ||
* states: list of state to log (default to all) | ||
- states: list of state to log (default to all) | ||
@@ -361,1 +365,3 @@ ```js | ||
[travis-image]: https://www.travis-ci.org/pgherveou/gulp-awspublish.svg?branch=master | ||
[packagephobia-image]: https://packagephobia.now.sh/badge?p=gulp-awspublish | ||
[packagephobia-url]: https://packagephobia.now.sh/result?p=gulp-awspublish |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
28184
362
+ Addedansi-colors@4.1.3(transitive)
+ Addedduplexify@4.1.3(transitive)
+ Addedpump@3.0.2(transitive)
+ Addedpumpify@2.0.1(transitive)
+ Addedreadable-stream@3.6.2(transitive)
+ Addedsafe-buffer@5.2.1(transitive)
+ Addedstring_decoder@1.3.0(transitive)
+ Addedthrough2@3.0.2(transitive)
+ Addedwhich-typed-array@1.1.15(transitive)
- Removedansi-colors@3.2.4(transitive)
- Removedduplexify@3.7.1(transitive)
- Removedpump@2.0.1(transitive)
- Removedpumpify@1.5.1(transitive)
- Removedthrough2@3.0.0(transitive)
- Removedwhich-typed-array@1.1.16(transitive)
Updatedansi-colors@^4.1.1
Updatedpumpify@^2.0.1
Updatedthrough2@^3.0.1