An open API service indexing awesome lists of open source software.

https://github.com/minutebase/ember-cli-deploy-git-tag

An ember-cli-deploy plugin to tag deploys in git
https://github.com/minutebase/ember-cli-deploy-git-tag

Last synced: about 1 year ago
JSON representation

An ember-cli-deploy plugin to tag deploys in git

Awesome Lists containing this project

README

          

# ember-cli-deploy-git-tag

> An ember-cli-deploy plugin to tag deploys in git

[![](https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-git-tag.svg)](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)

This plugin tags each deploy in git.

## 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-git-tag
```

- Run the pipeline

```bash
$ ember deploy
```

## Installation
Run the following command in your terminal:

```bash
ember install ember-cli-deploy-git-tag
```

## ember-cli-deploy Hooks Implemented

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

- `didDeploy`

## Configuration Options

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

### deployTag

A function to generate the tag

By default this will contain the environment and revision key prefixed with "deploy-", eg `deploy-development-123abc`

## Prerequisites

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

- `revisionData.revisionKey` (provided by [ember-cli-deploy-revision-data][4])
- `commandLineArgs.revisionKey` (provided by [ember-cli-deploy][3])

## Running Tests

- `npm test`

[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"
[3]: https://github.com/ember-cli/ember-cli-deploy "ember-cli-deploy"
[4]: https://github.com/ember-cli-deploy/ember-cli-deploy-revision-data "ember-cli-deploy-revision-data"