https://github.com/aureliosaraiva/ember-cli-deploy-github-deployments
https://github.com/aureliosaraiva/ember-cli-deploy-github-deployments
ember ember-addon ember-cli-deploy
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aureliosaraiva/ember-cli-deploy-github-deployments
- Owner: aureliosaraiva
- License: mit
- Created: 2017-08-19T14:59:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-20T19:51:46.000Z (over 8 years ago)
- Last Synced: 2025-06-15T03:42:41.944Z (10 months ago)
- Topics: ember, ember-addon, ember-cli-deploy
- Language: JavaScript
- Size: 26.4 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-deploy-github-deployments
> An ember-cli-deploy-plugin for setting the status deploy on a commit in a PR on [GitHub](https://github.com/).
[](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)
[](https://badge.fury.io/js/ember-cli-deploy-github-deployments)
## 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][2].
## Quick Start
To get up and running quickly, do the following:
- Install this plugin
```bash
$ ember install ember-cli-deploy-github-deployments
```
- Get a github api [token](https://github.com/settings/tokens) make sure the `repo:status` scope is selected
- Place the following configuration into `config/deploy.js`
```javascript
ENV['github-deployments'] = {
token: '',
username: ''
reporname: '',
publicURL: '',
commit: ''
}
```
## ember-cli-deploy Hooks Implemented
For detailed information on what plugin hooks are and how they work, please refer to the [Plugin Documentation][2].
- `configure`
- `willDeploy`
- `didDeploy`
- `didFail`
## Required Configuration Options
For detailed information on how configuration of plugins works, please refer to the [Plugin Documentation][2].
### 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](https://github.com/settings/tokens) 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][4]
- [ ] [Add Github status deployments in timeline][3]
[2]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"
[3]: https://developer.github.com/v3/repos/deployments/
[4]: https://developer.github.com/v3/gists/