Deploy projects 'atomically' to S3

A simple utility for deploying projects pseudo-atomically to Amazon S3.
It is designed to first upload assets that have content hashes, and
only then upload entry points assets like index.html.

Assets that are not entry points are also assigned a max-age header.
If not entry points, files of type css, json, js and svg are
compressed with gzip. For all gzipped assets, the necessary S3 object
metadata is added to allow them to be served properly.

Install

``shell
npm install atomic-s3 -g
`

Usage

The usage examples assume that necessary AWS credentials are provided.

$3

`shell
atomic-s3 --path=dist --bucket=my-bucket-name --region=eu-west-1
`

$3

Create a file called atomic-s3.config.js.
`js
module.exports = {
path: 'dist',
s3options: {
params: {
'Bucket': 'my-bucket-name'
}
region: 'eu-west-1'
}
};
`

Then simply run
`
atomic-s3
`

$3

`js
import atomicS3 from 'atomic-s3';

var opts = {
path: 'dist'
s3options: {
params: {
'Bucket': 'my-bucket-name'
}
region: 'eu-west-1'
}
};

atomicS3.publish(opts, (err, res) => {
if (err) {
console.log(Publish failed: ${err});
return;
}
console.log('Project published.');
});
`

Options

$3

- path: Local path to folder to publish.
- entryPoints: List of node glob patterns that together match all assets that are entry points, i.e. assets that do not have content hashes. Defaults to ['*/.html'], which matches only html files.
- maxAge: Value to use for the max-age header applied for assets that are not entry points. Defaults to 3600.
- force: Disable cache.

$3

- bucket: Name of Amazon S3 bucket in which to publish. Required.
- region: Amazon S3 region.
- verbose Enable verbose output.

$3

- path: Local path to folder to publish.
- s3options: S3 options. The most important options are region and params.Bucket. (See usage example.)

Test

Make sure you have the correct node version
`shell
nvm use
`

Then run tests with
`shell
npm test
`

$3

Make sure that necessary AWS credentials are in place
for the bucket configured in test/atomic-s3.config.js
and run the following in the project root:

`bash
node src/main-cli.js --config=test/atomic-s3.config.js --verbose
``