From 9788fcad4ecfb1a5210c4b6710b7cdadac31b61c Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Tue, 13 Feb 2018 16:21:34 -0500 Subject: [PATCH] feat: use `@semantic-release/github` as default for `success` and `fail` 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. --- docs/usage/configuration.md | 4 ++-- lib/definitions/plugins.js | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 2acbfa5a..b88d7093 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -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` @@ -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` diff --git a/lib/definitions/plugins.js b/lib/definitions/plugins.js index 98b1b17a..2e956e32 100644 --- a/lib/definitions/plugins.js +++ b/lib/definitions/plugins.js @@ -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)), },