Giter VIP home page Giter VIP logo

gulp-s3's Introduction

gulp-s3 NPM version

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   = require('gulp-s3')
var gulp = require('gulp')

var AWS = {
  "key":    process.env.AWS_ACCESS_KEY_ID,
  "secret": process.env.AWS_SECRET_ACCESS_KEY,
  "bucket": "dev.example.com",
  "region": "eu-west-1"
}

gulp.task('default', () => {
  gulp.src('./dist/**').pipe(s3(AWS));
});

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.src('./dist/**', {read: false})
    .pipe(s3(AWS, options));

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.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 options = { gzippedOnly: true };
gulp.src('./dist/**').pipe(gzip())
    .pipe(s3(AWS, options));

options.failOnError

Type: Boolean Default: false

Throw error if upload to s3 fails.

var options = { failOnError: true };
gulp.src('./dist/**').pipe(gzip())
    .pipe(s3(AWS, options));

License

MIT License

gulp-s3's People

Contributors

abhisekpaul avatar and-re avatar austinhallock avatar brunosiqueira avatar cyruskazemi avatar jtblin avatar mathisonian avatar mbjorkegren avatar mjackson avatar nitaigao avatar pon avatar steadicat avatar subinsebastien avatar travist avatar zoltanradics avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.