README.md

ember-cli-deploy-github-deployments

An ember-cli-deploy-plugin for setting the status deploy on a commit in a PR on GitHub.

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:

• Install this plugin

$ ember install ember-cli-deploy-github-deployments

• Get a github api token make sure the repo:status scope is selected

• Place the following configuration into config/deploy.js

ENV['github-deployments'] = {
  token: '<your-github-token>',
  username: '<user-name>'
  reporname: '<my-ember-app-repo>',
  publicURL: '<url-where-assets-will-be-viewed-from>',
  commit: '<sha-for-specific-commit>'
}

ember-cli-deploy Hooks Implemented

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

• configure
• willDeploy
• didDeploy
• didFail

Required Configuration Options

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

commit

The github commit sha that the status will be applied to. e.x https://github.com/my-user/:repo/commit/:sha

token

The token that will be used to set the status on the github commit.

username

The user or organization that owns the repo. e.x https://github.com/:username/my-repo

reporname

The user or organization that owns the reporname. e.x https://github.com/my-user/:reporname

publicURL

The url which your assets are going to be viewed from. e.x. https://my-app-domain.com/{{commit}}

Screenshot (Pipeline)

Pending deploy

ember-cli-deploy-github-deployments will set the status pending of the github commit on the willDeploy.

Success Deploy

ember-cli-deploy-github-deployments will set the status success of the github commit on the didDeploy.

Error Deploy

ember-cli-deploy-github-deployments will set the status error of the github commit on the didFail.

Roadmap

• Save log of deploy in Gist, when failure deploy
• Add Github status deployments in timeline