Registry / devops / ember-cli-deploy-build

ember-cli-deploy-build

JSON →
library3.0.0jsnpmunverified

The `ember-cli-deploy-build` package is a fundamental plugin within the `ember-cli-deploy` ecosystem, designed to facilitate the build process of Ember CLI applications as part of a continuous deployment pipeline. Its primary role is to compile and output all necessary application assets into a specified directory. It seamlessly integrates into the `ember-cli-deploy` workflow by implementing the `configure` and `build` pipeline hooks, handling tasks traditionally performed by `ember build`. The current stable version is 3.0.0, with a release cadence often tied to updates in Ember CLI itself and its underlying dependencies. This plugin differentiates itself by providing a robust, configurable build step that is abstracted and integrated directly into the deployment process, allowing developers to define build environments and output paths within their `config/deploy.js` file, ensuring consistency across deployments without manual intervention. It is not a standalone build tool but rather an essential component for automated Ember deployments.

npm install ember-cli-deploy-build
INSTALL
IMPORT
SIG · EMBER-CLI-DEPLOY-B
E
ember-cli-deploy-build
devopsjavascriptv3.0.0
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

No direct JavaScript imports
This package is an Ember CLI addon/plugin. Its functionality is integrated via `ember install` and configuration in `config/deploy.js`, not through direct JavaScript `import` or `require` statements in application code.
Ember CLI plugins are discovered and loaded by `ember-cli-deploy` after installation. You configure its behavior in `config/deploy.js` rather than importing symbols into your JavaScript files.
Configuration object in config/deploy.js
module.exports = function(deployTarget) { return { build: { environment: 'production', outputPath: 'dist' } }; };
import { build } from 'ember-cli-deploy-build';
The plugin is configured as an object within the `config/deploy.js` file, under the `build` key, allowing you to specify parameters like `environment` and `outputPath`.

This quickstart demonstrates how to install the `ember-cli-deploy-build` plugin, configure its behavior (like target environment and output path) within your `config/deploy.js` file, and then initiate a production deployment which will trigger the build process.

```bash # Install the plugin as an Ember CLI addon ember install ember-cli-deploy-build # Open or create config/deploy.js (generated by ember-cli-deploy) # and configure the build plugin (example below) # This tells the 'build' plugin how to operate # Add this to your config/deploy.js (adjust as needed): ``` ```javascript // config/deploy.js module.exports = function(deployTarget) { const ENV = { build: { environment: deployTarget === 'production' ? 'production' : 'development', outputPath: 'tmp/deploy-dist' // This is the default, but can be customized }, // ... other deploy plugins or configurations }; return ENV; }; ``` ```bash # Run the deployment pipeline; the 'build' plugin will execute automatically ember deploy production ```
Debug
Known issues
breakingVersion 3.0.0 introduces updated dependency requirements, including specific Node.js versions. Applications running on older Node.js versions may encounter errors.
fix
Ensure your project's Node.js environment meets the minimum requirements of '14.* || 16.* || 18.* || >= 20' as specified in the package's engines field. Update Node.js if necessary.
affects: >=3.0.0
breakingVersion 2.0.0 changed the default behavior to include hidden files (e.g., dotfiles like `.htaccess`) in the `distFiles` output, which affects what gets deployed.
fix
Review your deployment strategy for hidden files. If you previously relied on them being excluded, you might need to implement explicit exclusion rules in a subsequent `ember-cli-deploy` plugin (e.g., `s3`) or adjust your build output if possible.
affects: >=2.0.0 <3.0.0
gotchaRunning `ember test` directly for this package will not work as it is a Node-only Ember CLI addon and uses Mocha for testing, not the standard Ember CLI test runner.
fix
To run tests for `ember-cli-deploy-build` itself, use `yarn test` as described in its documentation. For your application's tests, use `ember test` as usual.
affects: >=0.1.0
gotchaFor faster iteration during plugin development or configuration tweaking, you can set the `EMBER_CLI_DEPLOY_REUSE_BUILD` environment variable to reuse the previous build output, but this should be used cautiously.
fix
Only use `EMBER_CLI_DEPLOY_REUSE_BUILD` when you are confident that your application code and build options (e.g., `environment`, `outputPath`) have not changed. Always perform a clean build for production deployments.
affects: >=1.1.0
Errors
Common errors & fixes
Error: The `build` plugin did not specify an `environment`.
The `environment` configuration option for the build plugin is missing or incorrectly defined in `config/deploy.js`.
fix
Ensure the `build` object in your `config/deploy.js` includes an `environment` property, e.g., `build: { environment: 'production' }`.
Error: Node.js version not supported.
Your current Node.js version is older than the minimum required by `ember-cli-deploy-build` v3.0.0.
fix
Upgrade your Node.js installation to version 14, 16, 18, or 20, or newer, as specified by the package's `engines` field.
Plugin `build` could not be found or loaded.
The `ember-cli-deploy-build` package was not correctly installed or `ember-cli-deploy` cannot locate it.
fix
Verify that `ember-cli-deploy-build` is listed in your `package.json` and try running `npm install` or `yarn install` again. Ensure `ember-cli-deploy` itself is also properly installed.
Upgrade
Version history
3.0.0latest on npm
Audit
Dependencies
ember-cli-deployrequiredThis package is a plugin for ember-cli-deploy and requires it to function within a deployment pipeline.
Agent activity
2 hits · last 30 days
node
2
Resources