Notify Firebase of deploys
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
addon
app
config
tests
vendor
.bowerrc
.editorconfig
.ember-cli
.gitignore
.jshintrc
.npmignore
.travis.yml
.watchmanconfig
LICENSE.md
README.md
bower.json
ember-cli-build.js
index.js
package.json
testem.json

README.md

ember-cli-deploy-notify-firebase

An ember-cli-deploy plugin to update a path in Firebase on activation

This plugin updates a path in Firebase with the latest version information when the deploy is activated.

Why would I want to do that?

The main use-case is to display a notification to your users when a version changes so they can reload to get changes.

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.

Quick Start

To get up and running quickly, do the following:

$ ember install ember-cli-deploy-notify-firebase
  • Place the following configuration into config/deploy.js
ENV.firebase {
  app: '<your-firebase-app>',
  token: '<your-firebase-token>'
}
  • Run the pipeline & activate a deploy
$ ember deploy --activate

or

$ ember deploy
$ ember activate <version>

Installation

Run the following command in your terminal:

ember install ember-cli-deploy-notify-firebase

ember-cli-deploy Hooks Implemented

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

  • didActivate

Configuration Options

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

app

The Firebase app to notify, the subdomain in https://.firebaseio.com

Default: null

token

A security token to authenticate with.

Default: null

path

The path to update in Firebase.

Default: '/release'

payload

The data to update in Firebase.

By default this will contain the revision key and a timestamp.

Default:

{
  "revision": "<revisionKey>",
  "at": "<timestamp>"
}

How do I activate a revision?

A user can activate a revision by either:

  • Passing a command line argument to the deploy command:
$ ember deploy --activate=true
  • Running the deploy:activate command:
$ ember deploy:activate <revision-key>
  • Setting the activateOnDeploy flag in deploy.js
ENV.pipeline {
  activateOnDeploy: true
}

Prerequisites

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

Running Tests

  • npm test