Skip to content

Commit

Permalink
feat: use @semantic-release/github as default for success and `fa…
Browse files Browse the repository at this point in the history
…il` hooks

BREAKING CHANGE: `success` and `fail` hooks are now enabled by default

In order to disable the `@semantic-release/github` plugin for the `success` and `fail` hook, the corresponding options have to be set to `false` in the **semantic-release** configuration:

```json
{
  "release": {
    "success": false,
    "fail": false
  }
}
```

Users who do not use the `@semantic-release/github` plugin, should disable it in the `success` and `fail` by setting the corresponding options to `false` or to alternative plugin providing `success` and `fail` hooks.
  • Loading branch information
pvdlg committed Feb 13, 2018
1 parent 04f3061 commit 9788fca
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/usage/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ See [Plugins configuration](plugins.md#configuration) for more details.

Type: `Array`, `String`, `Object`

Default: `[]`
Default: `['@semantic-release/github']`

CLI argument: `--success`

Expand All @@ -183,7 +183,7 @@ See [Plugins configuration](plugins.md#configuration) for more details.

Type: `Array`, `String`, `Object`

Default: `[]`
Default: `['@semantic-release/github']`

CLI argument: `--fail`

Expand Down
4 changes: 2 additions & 2 deletions lib/definitions/plugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ module.exports = {
},
},
success: {
default: false,
default: ['@semantic-release/github'],
config: {
validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
},
},
fail: {
default: false,
default: ['@semantic-release/github'],
config: {
validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
},
Expand Down

0 comments on commit 9788fca

Please sign in to comment.