ember-cli-deploy-archive

Ember CLI Deploy plugin to create an archive of your deployment build.

Usage no npm install needed!

<script type="module">
  import emberCliDeployArchive from 'https://cdn.skypack.dev/ember-cli-deploy-archive';
</script>

README

ember-cli-deploy-archive Build Status

Ember CLI Deploy plugin to create an archive of your deployment build.

Ember Observer Score npm

This plugin will create a tarball (.tar.gz) of your build directory and add it to the deployment context.

What is an ember-cli-deploy plugin?

A plugin is an addon that can be executed as a part of the ember-cli-deploy pipeline. A plugin will implement one or more of the ember-cli-deploy's pipeline hooks.

For more information on what plugins are and how they work, please refer to the Plugin Documentation.

Quick Start

To get up and running quickly, do the following:

$ ember install ember-cli-deploy-archive
  • Run the pipeline
$ ember deploy

ember-cli-deploy Hooks Implemented

For detailed information on what plugin hooks are and how they work, please refer to the Plugin Documentation.

  • configure
  • setup
  • willUpload

Configuration Options

For detailed information on how configuration of plugins works, please refer to the Plugin Documentation.

Defaults

  • Place the following configuration into config/deploy.js
ENV.archive = {
  archivePath: 'tmp/deploy-archive',
  archiveName: 'build.tar'
}

archivePath

The path to the directory you'd like the project to be archived in.

Default: tmp/deploy-archive

archiveName

The name of the archive to be created. Currently only .tar is supported (will be gzipped as well).

Default: build.tar

packedDirName

The name of the directory inside the tarball. By default, context.distDir is deploy-dist and gets packed up.
Override this if you need the unpacked directory to be named something other than deploy-dist.

Default: false

Deployment Context

archivePath and archiveName are added to the deployment context for use by other plugins. Note that this is done in the setup hook, not in willUpload (where most of the action happens). This is to ensure the properties are available to hooks that run during deploy:activate and deploy:list commands.

Prerequisites

The following properties are expected to be present on the deployment context object:

Running Tests

  • npm test

Acknowledgements

Big kudos to the Ember CLI Deploy core team and community for standardizing deployments and making a dead simple pipeline :ok_hand: