https://github.com/elidupuis/ember-cli-deploy-archive
Ember CLI Deploy plugin to create an archive of your deployment build.
https://github.com/elidupuis/ember-cli-deploy-archive
ember-cli-deploy-plugin
Last synced: about 1 month ago
JSON representation
Ember CLI Deploy plugin to create an archive of your deployment build.
- Host: GitHub
- URL: https://github.com/elidupuis/ember-cli-deploy-archive
- Owner: elidupuis
- License: mit
- Created: 2016-02-06T22:36:50.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2023-04-11T22:16:02.000Z (about 3 years ago)
- Last Synced: 2025-08-09T05:28:03.929Z (10 months ago)
- Topics: ember-cli-deploy-plugin
- Language: JavaScript
- Homepage:
- Size: 180 KB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-deploy-archive [](https://github.com/elidupuis/ember-cli-deploy-archive/actions/workflows/ci.yaml)
> Ember CLI Deploy plugin to create an archive of your deployment build.
[](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/) [](http://emberobserver.com/addons/ember-cli-deploy-archive) [](https://www.npmjs.com/package/ember-cli-deploy-archive)
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][1].
## Quick Start
To get up and running quickly, do the following:
- Ensure [ember-cli-deploy-build][2] is installed and configured.
- Install this plugin
```bash
$ ember install ember-cli-deploy-archive
```
- Run the pipeline
```bash
$ 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][1].
- `configure`
- `setup`
- `willUpload`
## Configuration Options
For detailed information on how configuration of plugins works, please refer to the [Plugin Documentation][1].
### Defaults
- Place the following configuration into `config/deploy.js`
```javascript
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:
- `distDir` (provided by [ember-cli-deploy-build][2])
## 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:
[1]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"
[2]: https://github.com/ember-cli-deploy/ember-cli-deploy-build "ember-cli-deploy-build"