gulp-s3
s3 plugin for gulp
Usage
First, install gulp-s3
as a development dependency:
npm install --save-dev gulp-s3
Then, use it in your gulpfile.js
:
var s3 = var gulp = var AWS = "key": processenvAWS_ACCESS_KEY_ID "secret": processenvAWS_SECRET_ACCESS_KEY "bucket": "dev.example.com" "region": "eu-west-1" gulp;
API
options.uploadPath
Type: String
Default: ``
Set the remote folder on the S3 bucket
var options = uploadPath: 'remote-folder' // It will upload the 'src' into '/remote-folder'gulp ;
options.headers
Type: Object
Default: {}
Headers to set to each file uploaded to S3
var options = headers: 'Cache-Control': 'max-age=315360000, no-transform, public' 'x-amz-acl': 'private' ;gulp ;
options.gzippedOnly
Type: Boolean
Default: false
Only upload files with .gz extension, additionally it will remove the .gz suffix on destination filename and set appropriate Content-Type and Content-Encoding headers.
var options = gzippedOnly: true ;gulp ;
options.failOnError
Type: Boolean
Default: false
Throw error if upload to s3 fails.
var options = failOnError: true ;gulp ;