# ember-cli-deploy-circleci-revision

> An ember-cli-deploy plugin to add CircleCI build number to the revision key generated by ember-cli-deploy-revision-data

Latest version **0.0.2** (published 2020-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-cli-deploy-circleci-revision
pnpm add ember-cli-deploy-circleci-revision
yarn add ember-cli-deploy-circleci-revision
bun add ember-cli-deploy-circleci-revision
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-04-13 |
| First published | 2018-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 1 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | danielcms |
| Keywords | ember-addon, ember-cli-deploy-plugin |

## Links

- npm: https://www.npmjs.com/package/ember-cli-deploy-circleci-revision
- Repository: https://github.com/DanielCMS/ember-cli-deploy-circleci-revision
- Homepage: https://github.com/DanielCMS/ember-cli-deploy-circleci-revision#readme
- Issues: https://github.com/DanielCMS/ember-cli-deploy-circleci-revision/issues
- npm.io page: https://npm.io/package/ember-cli-deploy-circleci-revision

## Dependencies (1)

- [ember-cli-deploy-plugin](https://npm.io/package/ember-cli-deploy-plugin.md) ^0.2.9

## Recent versions

- 0.0.2 (latest) — 2020-04-13
- 0.0.1 — 2018-11-12

## README

# ember-cli-deploy-circleci-revision

> An ember-cli-deploy plugin to add the CircleCI build number to the key generated from [ember-cli-deploy-revision-data](https://github.com/ember-cli-deploy/ember-cli-deploy-revision-data). It reads the `revisionKey` variable added by [ember-cli-deploy-revision-data](https://github.com/ember-cli-deploy/ember-cli-deploy-revision-data) and append proper CircleCI build number if possible.

## 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-revision-data][2] is installed and configured

- Install this plugin


## Installation
Run the following command in your terminal:

```bash
ember install ember-cli-deploy-circleci-revision
```

## ember-cli-deploy Hooks Implemented

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

- `prepare`

## Configuration Options

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

### Defaults
```
ENV["circleci-revision"] = {
  buildVariable: "CIRCLE_BUILD_NUM",
  separator: '_'
}
```
The `buildVariable` specifies the environement variable to use to extract the build number. This can be useful if you want your build number to be externally supplied, say from a parent task.
## Prerequisites

The following property is expected to be present on the deployment `context` object:

- `revisionKey` (provided by [ember-cli-deploy-revision-data][2])


[1]: http://ember-cli-deploy.com/ "Plugin Documentation"
[2]: https://github.com/ember-cli-deploy/ember-cli-deploy-revision-data "ember-cli-deploy-revision-data"
[3]: https://github.com/ember-cli-deploy/ember-cli-deploy-build "ember-cli-deploy-build"
[4]: https://github.com/ember-cli/ember-cli-deploy "ember-cli-deploy"

---
_Source: https://npm.io/package/ember-cli-deploy-circleci-revision · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
