Skip to content
This repository has been archived by the owner on Apr 17, 2020. It is now read-only.

Rename the plugin to ember-cli-deploy-webhooks #14

Merged
merged 1 commit into from
Mar 11, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# ember-cli-deploy-notifications [![Build Status](https://travis-ci.org/simplabs/ember-cli-deploy-notifications.svg)](https://travis-ci.org/simplabs/ember-cli-deploy-notifications)
# ember-cli-deploy-webhooks [![Build Status](https://travis-ci.org/simplabs/ember-cli-deploy-webhooks.svg)](https://travis-ci.org/simplabs/ember-cli-deploy-webhooks)

> An ember-cli-deploy plugin to notify external services (e.g. an error
> tracking service) of successful hook executions in your deploy pipeline.

[![](https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-notifications.svg)](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)
[![](https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-webhooks.svg)](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)

## What is an ember-cli-deploy plugin?

Expand All @@ -18,13 +18,13 @@ To get up and running quickly, do the following:
- Install this plugin

```bash
$ ember install ember-cli-deploy-notifications
$ ember install ember-cli-deploy-webhooks
```
- Place the following configuration into `config/deploy.js`


```javascript
ENV.notifications = {
ENV.webhooks = {
services: {
"<some-key>": {
url: <service-url>,
Expand Down Expand Up @@ -57,7 +57,7 @@ For detailed information on what plugin hooks are and how they work, please refe
- `configure`
- `setup`

_Hooks that can be used for notifications:_
_Hooks that can be used for webhooks:_

- `willDeploy`
- `willBuild`
Expand Down Expand Up @@ -86,7 +86,7 @@ For detailed information on how configuration of plugins works, please refer to
An object that identifies all webhooks you want to notify. You will put a key for every service you want to call on deploy here.

A `service` configuration needs to provide four properties as configuration for
`ember-cli-deploy-notifications` to know how to notify the service correctly:
`ember-cli-deploy-webhooks` to know how to notify the service correctly:

- `url` The url to call
- `method` The HTTP-method to use for the call (defaults to `'POST'`)
Expand All @@ -101,7 +101,7 @@ A `service` configuration needs to provide four properties as configuration for

Bearer authentication is also supported. Please refer to
[request](https://github.com/request/request#http-authentication)'s docs for
more details as `ember-cli-deploy-notifications` uses `request` internally.
more details as `ember-cli-deploy-webhooks` uses `request` internally.

<hr/>
**Whenever one of these properties (except `auth`) returns a _falsy_ value, the service will _not_ be
Expand All @@ -116,7 +116,7 @@ itself.
*Example:*

```javascript
ENV.notifications = {
ENV.webhooks = {
services: {
slack: {
webhookURL: '<your-webhook-url>',
Expand Down Expand Up @@ -145,7 +145,7 @@ als be used to override the defaults that you specify on a service.
*Example:*

```javascript
ENV.notifications = {
ENV.webhooks = {
services: {
slack: {
url: 'your-webhook-url',
Expand Down Expand Up @@ -182,7 +182,7 @@ the defaults.
*Example:*

```javascript
ENV.notifications = {
ENV.webhooks = {
services: {
bugsnag: {
url: 'https://bugsnag.simplabs.com/deploy',
Expand All @@ -199,7 +199,7 @@ plugin users. This for example is basically the default implementation that is
already configured for the slack service:

```javascript
ENV.notifications.services = {
ENV.webhooks.services = {
// ...
slack: {
url: function() {
Expand All @@ -217,7 +217,7 @@ hooks that should send a message to slack.
*Example:*

```javascript
ENV.notifications.services = {
ENV.webhooks.services = {
slack: {
webhookURL: '<your-slack-webhook-url>',
didActivate: {
Expand All @@ -244,7 +244,7 @@ hook that actually makes a new version of your app available to your users.
*Example:*

```javascript
ENV.notifications.services = {
ENV.webhooks.services = {
bugsnag: {
apiKey: '<your-api-key>',
didActivate: true
Expand All @@ -260,7 +260,7 @@ __Required configuration__
__Default configuration__

```
ENV.notifications.services = {
ENV.webhooks.services = {
bugsnag: {
url: 'http://notify.bugsnag.com/deploy',
method: 'POST',
Expand All @@ -284,7 +284,7 @@ __Default configuration__
*Example:*

```javascript
ENV.notifications.services = {
ENV.webhooks.services = {
slack: {
webhookURL: '<your-slack-webhook-url>',
didActivate: {
Expand All @@ -308,7 +308,7 @@ least you have to provide a `text` property in the payload.
__Default configuration__

```javascript
ENV.notifications.services = {
ENV.webhooks.services = {
// ...
slack: {
url: function() {
Expand All @@ -329,7 +329,7 @@ options can be overridden as described before of course.
*Example:*

```javascript
ENV.notifications = {
ENV.webhooks = {
services: {
simplabs: {
url: 'https://notify.simplabs.com/deploy',
Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ function notificationHook(hookName) {
}

module.exports = {
name: 'ember-cli-deploy-notifications',
name: 'ember-cli-deploy-webhooks',

createDeployPlugin: function(options) {
var DeployPlugin = DeployPluginBase.extend({
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "ember-cli-deploy-notifications",
"version": "0.2.0",
"description": "Ember CLI Deploy plugin to notify external services during deployments.",
"name": "ember-cli-deploy-webhooks",
"version": "0.3.0",
"description": "Ember CLI Deploy plugin to notify webhooks/services during deployments.",
"directories": {
"doc": "doc",
"test": "tests"
Expand All @@ -11,7 +11,7 @@
"start": "ember server",
"test": "node tests/runner.js"
},
"repository": "https://github.com/simplabs/ember-cli-deploy-notifications",
"repository": "https://github.com/simplabs/ember-cli-deploy-webhooks",
"engines": {
"node": ">= 0.10.0"
},
Expand Down
10 changes: 5 additions & 5 deletions tests/unit/index-nodetest.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
var Promise = require('ember-cli/lib/ext/promise');
var assert = require('ember-cli/tests/helpers/assert');

describe('notifications plugin', function() {
describe('webhooks plugin', function() {
var subject, plugin, context, mockUi, mockHTTP, services, serviceCalls, callbackReturnValue;

var BUGSNAG_URI = 'http://notify.bugsnag.com/deploy';
Expand All @@ -14,7 +14,7 @@ describe('notifications plugin', function() {
serviceCalls = [];

plugin = subject.createDeployPlugin({
name: 'notifications'
name: 'webhooks'
});

callbackReturnValue = undefined;
Expand Down Expand Up @@ -55,7 +55,7 @@ describe('notifications plugin', function() {
ui: mockUi,

config: {
notifications: {
webhooks: {
services: services,
httpClient: mockHTTP
}
Expand All @@ -64,7 +64,7 @@ describe('notifications plugin', function() {
});

it('has a name', function() {
assert.equal(plugin.name, 'notifications');
assert.equal(plugin.name, 'webhooks');
});

describe('configuring services', function() {
Expand Down Expand Up @@ -287,7 +287,7 @@ describe('notifications plugin', function() {

describe('user configured services', function() {
it('allows to notify services that are not preconfigured', function() {
var CUSTOM_URI = 'https://my-custom-hack.com/deployment-notifications';
var CUSTOM_URI = 'https://my-custom-hack.com/deployment-webhooks';

services.custom = {
url: CUSTOM_URI,
Expand Down