{"id":17018829,"url":"https://github.com/aureliosaraiva/ember-cli-deploy-github-deployments","last_synced_at":"2026-05-08T15:05:36.447Z","repository":{"id":57223185,"uuid":"100801633","full_name":"aureliosaraiva/ember-cli-deploy-github-deployments","owner":"aureliosaraiva","description":null,"archived":false,"fork":false,"pushed_at":"2017-08-20T19:51:46.000Z","size":27,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-15T03:42:41.944Z","etag":null,"topics":["ember","ember-addon","ember-cli-deploy"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aureliosaraiva.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-19T14:59:46.000Z","updated_at":"2017-08-24T15:15:14.000Z","dependencies_parsed_at":"2022-08-25T14:41:40.837Z","dependency_job_id":null,"html_url":"https://github.com/aureliosaraiva/ember-cli-deploy-github-deployments","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/aureliosaraiva/ember-cli-deploy-github-deployments","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureliosaraiva%2Fember-cli-deploy-github-deployments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureliosaraiva%2Fember-cli-deploy-github-deployments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureliosaraiva%2Fember-cli-deploy-github-deployments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureliosaraiva%2Fember-cli-deploy-github-deployments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aureliosaraiva","download_url":"https://codeload.github.com/aureliosaraiva/ember-cli-deploy-github-deployments/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aureliosaraiva%2Fember-cli-deploy-github-deployments/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262001137,"owners_count":23243004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ember","ember-addon","ember-cli-deploy"],"created_at":"2024-10-14T06:47:14.132Z","updated_at":"2026-05-08T15:05:36.390Z","avatar_url":"https://github.com/aureliosaraiva.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ember-cli-deploy-github-deployments\n\n\u003e An ember-cli-deploy-plugin for setting the status deploy on a commit in a PR on [GitHub](https://github.com/).\n\n[![](https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-s3.svg)](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)\n[![npm version](https://badge.fury.io/js/ember-cli-deploy-github-deployments.svg)](https://badge.fury.io/js/ember-cli-deploy-github-deployments)\n\n## What is an ember-cli-deploy plugin?\n\nA 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.\n\nFor more information on what plugins are and how they work, please refer to the [Plugin Documentation][2].\n\n\n## Quick Start\n\nTo get up and running quickly, do the following:\n\n- Install this plugin\n\n```bash\n$ ember install ember-cli-deploy-github-deployments\n```\n\n- Get a github api [token](https://github.com/settings/tokens) make sure the `repo:status` scope is selected\n\n- Place the following configuration into `config/deploy.js`\n\n```javascript\nENV['github-deployments'] = {\n  token: '\u003cyour-github-token\u003e',\n  username: '\u003cuser-name\u003e'\n  reporname: '\u003cmy-ember-app-repo\u003e',\n  publicURL: '\u003curl-where-assets-will-be-viewed-from\u003e',\n  commit: '\u003csha-for-specific-commit\u003e'\n}\n```\n\n## ember-cli-deploy Hooks Implemented\n\nFor detailed information on what plugin hooks are and how they work, please refer to the [Plugin Documentation][2].\n\n- `configure`\n- `willDeploy`\n- `didDeploy`\n- `didFail`\n\n## Required Configuration Options\n\nFor detailed information on how configuration of plugins works, please refer to the [Plugin Documentation][2].\n\n### commit\n\nThe github commit sha that the status will be applied to. e.x https://github.com/my-user/:repo/commit/:sha\n\n### token\n\nThe [token](https://github.com/settings/tokens) that will be used to set the status on the github commit.\n\n### username\n\nThe user or organization that owns the repo. e.x https://github.com/:username/my-repo\n\n### reporname\n\nThe user or organization that owns the reporname. e.x https://github.com/my-user/:reporname\n\n### publicURL\n\nThe url which your assets are going to be viewed from. e.x. https://my-app-domain.com/{{commit}}\n\n## Screenshot (Pipeline)\n\n### Pending deploy\n`ember-cli-deploy-github-deployments` will set the status `pending` of the github commit on the willDeploy.\n\n![screenshot from 2017-08-20 14-08-42](https://user-images.githubusercontent.com/118861/29496839-452f279e-85b1-11e7-9ea0-0c9d608f3043.png)\n\n### Success Deploy\n`ember-cli-deploy-github-deployments` will set the status `success` of the github commit on the didDeploy.\n\n![screenshot from 2017-08-20 14-07-10](https://user-images.githubusercontent.com/118861/29496840-452fb4e8-85b1-11e7-9706-4e2f0f8d2863.png)\n\n### Error Deploy\n`ember-cli-deploy-github-deployments` will set the status `error` of the github commit on the didFail.\n\n![screenshot from 2017-08-20 14-09-04](https://user-images.githubusercontent.com/118861/29496838-452ec646-85b1-11e7-9319-3769c06155a9.png)\n\n## Roadmap\n- [ ] [Save log of deploy in Gist, when failure deploy][4]\n- [ ] [Add Github status deployments in timeline][3]\n\n[2]: http://ember-cli.github.io/ember-cli-deploy/plugins \"Plugin Documentation\"\n[3]: https://developer.github.com/v3/repos/deployments/\n[4]: https://developer.github.com/v3/gists/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faureliosaraiva%2Fember-cli-deploy-github-deployments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faureliosaraiva%2Fember-cli-deploy-github-deployments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faureliosaraiva%2Fember-cli-deploy-github-deployments/lists"}