An ember-cli-deploy-plugin for setting the status on a commit in a PR on GitHub.
This repository is deprecated. Please use ember-cli-deploy-github-status instead.
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
-
Get a github api token make sure the
repo:status
scope is selected -
Place the following configuration into
config/deploy.js
ENV.github = {
token: '<your-github-token>',
userOrOrganization: '<user-name>'
repo: '<my-ember-app-repo>',
publicURL: '<url-where-assets-will-be-viewed-from>',
commitUser: '<who-made-the-commit',
commitSha: '<sha-for-specific-commit>'
}
-
Ensure that the following environment variables are set:
- CI
-
Run the pipeline
$ ember deploy pull-request
For detailed information on what plugin hooks are and how they work, please refer to the Plugin Documentation.
configure
willActivate
didDeploy
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 github user that committed the code
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/:userOrOrganization/my-repo
The user or organization that owns the repo. e.x https://github.com/my-user/:repo
The url which your assets are going to be viewed from. e.x. https://my-app-domain.com If you want to be able to a specific version of the index file you must include {{versionSha}} in the publicUrl e.x https://my-app-domain.com/{{versionSha}} This will get replaced and look like https://my-app-domain.com/index.html:123abf
ember-cli-deploy-github
will set the status of the github commit on the didDeploy
.