An ember-cli-deploy-plugin for setting the status deploy on a commit in a PR on GitHub.
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.
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:statusscope 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>'
}For detailed information on what plugin hooks are and how they work, please refer to the Plugin Documentation.
configurewillDeploydidDeploydidFail
For detailed information on how configuration of plugins works, please refer to the Plugin Documentation.
The github commit sha that the status will be applied to. e.x https://github.com/my-user/:repo/commit/:sha
The token that will be used to set the status on the github commit.
The user or organization that owns the repo. e.x https://github.com/:username/my-repo
The user or organization that owns the reporname. e.x https://github.com/my-user/:reporname
The url which your assets are going to be viewed from. e.x. https://my-app-domain.com/{{commit}}
ember-cli-deploy-github-deployments will set the status pending of the github commit on the willDeploy.
ember-cli-deploy-github-deployments will set the status success of the github commit on the didDeploy.
ember-cli-deploy-github-deployments will set the status error of the github commit on the didFail.
