Name: atomic-s3
Owner: Lucify
Description: Deploy projects "atomically" to S3
Created: 2016-05-24 14:28:14.0
Updated: 2017-12-09 20:26:13.0
Pushed: 2017-07-31 13:15:28.0
Homepage: null
Size: 26
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
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 atomic-s3 -g
The usage examples assume that necessary AWS credentials are provided.
ic-s3 --path=dist --bucket=my-bucket-name --region=eu-west-1
Create a file called atomic-s3.config.js
.
le.exports = {
th: 'dist',
options: {
params: {
'Bucket': 'my-bucket-name'
}
region: 'eu-west-1'
Then simply run
ic-s3
rt atomicS3 from 'atomic-s3';
opts = {
th: 'dist'
options: {
params: {
'Bucket': 'my-bucket-name'
}
region: 'eu-west-1'
icS3.publish(opts, (err, res) => {
(err) {
console.log(`Publish failed: ${err}`);
return;
nsole.log('Project published.');
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.bucket
: Name of Amazon S3 bucket in which to publish. Required.region
: Amazon S3 region.verbose
Enable verbose output.path
: Local path to folder to publish.s3options
: [S3 options](<http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property). The most important options are region
and params.Bucket
. (See usage example.)Make sure you have the correct node version
use
Then run tests with
test
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:
src/main-cli.js --config=test/atomic-s3.config.js --verbose