delivr

Build your code and ship it to S3


Keywords
auto, automatic, automated, build, builds, continuous, integration, integrations, delivery, deliveries, upload, deploy, deployment, deployments, ci, cd, AWS, S3, process, processes, tool, tools, tooling, automation, ship
License
MPL-2.0
Install
npm install delivr@0.1.0

Documentation

delivr Build status for delivr

Build your code and ship it to S3

Why?

  • Easy to set up and configure.
  • Encourages cache-safe URLs.
  • Provides both versioned and latest copies.
  • Composable with other build tools.

Install

npm install delivr --save

Usage

Get it into your program.

const delivr = require('delivr');

Run the build.

const build = await delivr.prepare();
// Put stuff in here:
console.log('Temp dir:', build.path);

// ... some time later ...

// Move the temp dir to its permanent home, set up symlinks,
// and upload the files on disk to S3.
await build.finalize();

API

Please see Amazon's API documentation for details on bucket names and authenticating with AWS.

delivr.prepare(option)

Returns a Promise for an object with these fields:

  • path is a newly created temporary directory for you to write the build to.
  • finalize() moves path to its final location, links it, and uploads it to S3.

option

Type: object

Settings and known build data.

cwd

Type: string
Default: process.cwd()

Parent directory of the build root.

branch

Type: string

A git branch name, can be provided to improve performance or override git. Used to create paths for writing and deploying the build.

version

Type: string

A build version, can be provided to improve performance or use a specific version. Defaults to a newly generated version. Used to create paths for writing and deploying the build.

bucket

Type: string

Bucket name to use for deploying the build files to S3.

deploy

Type: boolean
Default: true if running in CI

Whether to deploy the build files to S3.

Related

Contributing

See our contributing guidelines for more details.

  1. Fork it.
  2. Make a feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.