gulp-s3-ls

s3 plugin for gulp

Usage

First, install gulp-s3-ls as a development dependency:

npm install --save-dev gulp-s3-ls

Setup your aws.json file

{
  "key": "AKIAI3Z7CUAFHG53DMJA",
  "secret": "acYxWRu5RRa6CwzQuhdXEfTpbQA+1XQJ7Z1bGTCx",
  "bucket": "dev.example.com"
}

Then, use it in your gulpfile.js:

var gulp = require("gulp");
var s3 = require("gulp-s3-ls");
var aws = require("./aws.json");

gulp.src('./dist/**')
    .pipe(s3(aws));

Flags

--dry

To test uploading files to s3 add the --dry flag and gulp-s3-ls will print out the files and the corresponding upload path.

gulp upload --dry

API

options.headers

Type: Array
Default: []

Headers to set to each file uploaded to S3

var gulp = require("gulp");
var s3 = require("gulp-s3-ls");
var aws = require("./aws.json");
var options = { headers: {'Cache-Control': 'max-age=315360000, no-transform, public'} };

gulp.src('./dist/**', {read: false})
    .pipe(s3(aws, options));

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 gulp = require("gulp");
var s3 = require("gulp-s3-ls");
var aws = require("./aws.json");
var gzip = require("gulp-gzip");
var options = { gzippedOnly: true };

gulp.src('./dist/**')
.pipe(gzip())
.pipe(s3(aws, options));

License

MIT License