S3 Plugin

This plugin will upload all built assets to s3

Install Instructions

$ npm i webpack-s3-plugin

Note: This plugin needs NodeJS > 0.12.0

Usage Instructions

Require webpack-s3-plugin

var S3Plugin = require('webpack-s3-plugin')

With exclude

var config = {
  plugins: [
    new S3Plugin({
      // Exclude uploading of html
      exclude: /.*\.html$/,
      // s3Options are required
      s3Options: {
        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
        region: 'us-west-1'
      },
      s3UploadOptions: {
        Bucket: 'MyBucket'
      },
      cdnizerOptions: {
        defaultCDNBase: 'http://asdf.ca'
      }
    })
  ]
}

With include

var config = {
  plugins: [
    new S3Plugin({
      // Only upload css and js
      include: /.*\.(css|js)/,
      // s3Options are required
      s3Options: {
        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
      },
      s3UploadOptions: {
        Bucket: 'MyBucket'
      }
    })
  ]
}

With CloudFront invalidation

var config = {
  plugins: [
    new S3Plugin({
      // Only upload css and js
      include: /.*\.(css|js)/,
      // s3Options are required
      s3Options: {
        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
      },
      s3UploadOptions: {
        Bucket: 'MyBucket'
      },
      cloudfrontInvalidateOptions: {
        DistributionId: process.env.CLOUDFRONT_DISTRIBUTION_ID,
        Items: ["/*"]
      }
    })
  ]
}

With latest Git commit hash as a directory suffix

var config = {
  plugins: [
    new S3Plugin({
      // Only upload css and js
      include: /.*\.(css|js)/,
      // s3Options are required
      s3Options: {
        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
      },
      s3UploadOptions: {
        Bucket: 'MyBucket'
      },
      addGitHash: true
    })
  ]
}

Options

• exclude: Regex to match for excluded content
• include: Regex to match for included content
• s3Options: Provide keys for upload extention of s3Config
• s3UploadOptions: Provide upload options putObject
• basePath: Provide the namespace where upload files on S3
• directory: Provide a directory to upload (if not supplied will upload js/css from compilation)
• htmlFiles: Html files to cdnize (defaults to all in output directory)
• noCdnizer: Disable cdnizer (defaults true if no cdnizerOptions passed)
• cdnizerOptions: options to pass to cdnizer
• addGitHash: option for adding latest git commit truncated SHA as a suffix to the deepest S3 directory

Contributing

All contributions are welcome. Please make a pull request and make sure things still pass after running npm run test For tests you will need to either have the environment variables set or setup a .env file. There's a .env.sample so you can cp .env.sample .env and fill it in. Make sure to add any new environment variables.

Commands to be aware of

WARNING: The test suit generates random files for certain checks. Ensure you delete files leftover on your Bucket.

• npm run test - Run test suit (You must have the .env file setup)
• npm run build - Run build

Thanks

• Thanks to @Omer for fixing credentials from ~/.aws/credentials
• Thanks to @lostjimmy for pointing out path.sep for Windows compatibility