Ember CLI Deploy Display Revisions

3.0.0 · active · verified Wed Apr 22

ember-cli-deploy-display-revisions is an Ember CLI Deploy plugin designed to list and display deployed revisions for Ember applications. Its current stable version is 3.0.0. This plugin integrates directly with the ember-cli-deploy ecosystem, providing a CLI command (`ember deploy:list`) to show recent deployments. It allows configuration of the number of revisions to display and expects revision data to be provided by other index plugins (e.g., fetchRevisions) in a specific JSON format, including details like `revision`, `version`, `timestamp`, `deployer`, and `active` status. The plugin is primarily a Node.js-only addon, meaning it does not participate in typical Ember application build or test processes, distinguishing it from front-end focused Ember addons. Release cadence is driven by updates to core dependencies like Node.js and ember-cli-deploy itself.

Common errors

```
Error: Node.js version X.X.X is not supported by ember-cli-deploy-display-revisions@3.0.0
```
cause Attempting to use the plugin with an unsupported Node.js version, especially prior to v14.

fix Update your Node.js environment to a compatible version (14.*, 16.*, 18.*, or >= 20).
```
ember deploy:list: command not found
```
cause `ember-cli-deploy-display-revisions` is installed, but `ember-cli-deploy` itself, or its `deploy` command, is not properly set up.

fix Ensure `ember-cli-deploy` is correctly installed in your project and configured. Verify that `ember deploy --help` works, indicating the `deploy` command is available.
```
The 'revisions' data does not display correctly or shows incorrect dates.
```
cause The `timestamp` format provided by the `fetchRevisions` plugin is not correctly parsed by Luxon after the v2.1.0 update.

fix Verify that your `fetchRevisions` plugin provides timestamps in the `context.revisions` array as either milliseconds since epoch or a valid ISO 8601 string, as expected by Luxon. For example: `{ revision: 'abc', timestamp: 1438232435000 }` or `{ revision: 'abc', timestamp: '2015-07-30T10:00:00.000Z' }`.

Warnings

breaking Version 3.0.0 introduces updated dependency requirements and significantly stricter Node.js version requirements, now demanding `14.* || 16.* || 18.* || >= 20`.
Fix: Ensure your project's Node.js environment meets the new requirements (Node.js v14, v16, v18, or v20+). Update your Node.js version if necessary. You may also need to update `ember-cli` and `ember-cli-deploy` to compatible versions.
breaking Version 2.0.0 broke compatibility for older Node.js environments, requiring Node.js 10 or higher, and also included updates to `ember-cli` dependencies.
Fix: Upgrade your Node.js environment to version 10 or higher. Review your `package.json` for `ember-cli` and `ember-cli-deploy` versions and update them if they are incompatible with Node 10+.
gotcha As a Node-only Ember CLI addon, `ember-cli-deploy-display-revisions` does not work with standard `ember build` or `ember test` commands directly within your application's test suite or build process.
Fix: This is expected behavior. The plugin's functionality is exposed via `ember deploy:*` commands and its internal tests are run via `yarn test` in its own repository, not within your application context. Do not try to include this plugin in your Ember application's `app` or `tests` directories in a way that would trigger Ember CLI's build or test lifecycles.
gotcha With the internal switch from Moment.js to Luxon in v2.1.0 and subsequent bug fixes in v2.1.1 and v2.1.2, users might encounter issues with timestamp parsing and display if revision data timestamps are not in the expected milliseconds-since-epoch or ISO format.
Fix: Ensure that the `timestamp` field in the `context.revisions` data provided by your `fetchRevisions` plugin is either a millisecond timestamp (e.g., `1438232435000`) or a valid ISO 8601 string to be correctly parsed by Luxon.

Install

npm install ember-cli-deploy-display-revisions npm
yarn add ember-cli-deploy-display-revisions yarn
pnpm add ember-cli-deploy-display-revisions pnpm

Imports

Installation
wrong:
```
import 'ember-cli-deploy-display-revisions'; // Not a direct JS module import
```
correct:
```
ember install ember-cli-deploy-display-revisions
```
This is an Ember CLI addon, primarily integrated via the `ember install` command. Direct JavaScript module imports into application code are not the typical use case.
Display Revisions Command
wrong:
```
require('ember-cli-deploy-display-revisions'); // No direct programmatic API for CLI commands
```
correct:
```
ember deploy:list <environment> [--amount <N>]
```
The core functionality is exposed through the Ember CLI `deploy:list` command. It takes an environment argument and an optional `--amount` flag.
Configuration
```
ENV['display-revisions'] = { amount: 10, revisions: function(context) { return context.revisions; } };
```
Configuration options like `amount` and `revisions` (the data source) are typically set in your Ember application's `config/environment.js` file under the `ENV['display-revisions']` key.

Quickstart

This quickstart demonstrates how to install the plugin and use its primary CLI commands to list deployed revisions, including an example of specifying the number of revisions to display.

ember install ember-cli-deploy-display-revisions

# Configure in config/environment.js (example)
// ENV['display-revisions'] = {
//   amount: 15, // Display up to 15 revisions
//   revisions: function(context) {
//     return context.revisions; // Use revisions from the deploy context
//   }
// };

# To list the latest 10 deployed revisions for the 'production' environment
ember deploy:list production

# To list the latest 5 deployed revisions for the 'staging' environment
ember deploy:list --amount 5 staging

view raw JSON →