d548edcf37
- Add a new plugin type: `publish` - Add support for multi-plugin. A plugin module can now return an object with a property for each plugin type - Uses by default [npm](https://github.com/semantic-release/npm) and [github](https://github.com/semantic-release/github) in addition of Travis for the verify condition plugin - Uses by default [npm](https://github.com/semantic-release/npm) and [github](https://github.com/semantic-release/github) for the publish plugin - `gitTag` if one can be found is passed to `generateNotes` for both `lastRelease` and `nextRelease` - `semantic-release` now verifies the plugin configuration (in the `release` property of `package.json`) and throws an error if it's invalid - `semantic-release` now verifies each plugin output and will throw an error if a plugin returns an unexpected value. BREAKING CHANGE: `githubToken`, `githubUrl` and `githubApiPathPrefix` have to be set at the [github](https://github.com/semantic-release/github) plugin level. They can be set via `GH_TOKEN`, `GH_URL` and `GH_PREFIX` environment variables. BREAKING CHANGE: the `npm` parameter is not passed to any plugin anymore. Each plugin have to read `.npmrc` if they needs to (with https://github.com/kevva/npm-conf for example).
79 lines
3.4 KiB
JavaScript
79 lines
3.4 KiB
JavaScript
const {isString, isObject, isFunction, isArray} = require('lodash');
|
|
const semver = require('semver');
|
|
const conditionTravis = require('@semantic-release/condition-travis');
|
|
const commitAnalyzer = require('@semantic-release/commit-analyzer');
|
|
const releaseNotesGenerator = require('@semantic-release/release-notes-generator');
|
|
const npm = require('@semantic-release/npm');
|
|
const github = require('@semantic-release/github');
|
|
|
|
const RELEASE_TYPE = ['major', 'premajor', 'minor', 'preminor', 'patch', 'prepatch', 'prerelease'];
|
|
|
|
module.exports = {
|
|
verifyConditions: {
|
|
default: [npm.verifyConditions, github.verifyConditions, conditionTravis],
|
|
config: {
|
|
validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
|
|
message:
|
|
'The "verifyConditions" plugin, if defined, must be a single or an array of plugins definition. A plugin definition is either a string or an object with a path property.',
|
|
},
|
|
},
|
|
getLastRelease: {
|
|
default: npm.getLastRelease,
|
|
config: {
|
|
validator: conf => Boolean(conf) && validatePluginConfig(conf),
|
|
message:
|
|
'The "getLastRelease" plugin is mandatory, and must be a single plugin definition. A plugin definition is either a string or an object with a path property.',
|
|
},
|
|
output: {
|
|
validator: output =>
|
|
!output ||
|
|
(isObject(output) && !output.version) ||
|
|
(isString(output.version) && Boolean(semver.valid(semver.clean(output.version)))),
|
|
message:
|
|
'The "getLastRelease" plugin output if defined, must be an object with an optionnal valid semver version in the "version" property.',
|
|
},
|
|
},
|
|
analyzeCommits: {
|
|
default: commitAnalyzer,
|
|
config: {
|
|
validator: conf => Boolean(conf) && validatePluginConfig(conf),
|
|
message:
|
|
'The "analyzeCommits" plugin is mandatory, and must be a single plugin definition. A plugin definition is either a string or an object with a path property.',
|
|
},
|
|
output: {
|
|
validator: output => !output || RELEASE_TYPE.includes(output),
|
|
message: 'The "analyzeCommits" plugin output must be either undefined or a valid semver release type.',
|
|
},
|
|
},
|
|
verifyRelease: {
|
|
default: false,
|
|
config: {
|
|
validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
|
|
message:
|
|
'The "verifyRelease" plugin, if defined, must be a single or an array of plugins definition. A plugin definition is either a string or an object with a path property.',
|
|
},
|
|
},
|
|
generateNotes: {
|
|
default: releaseNotesGenerator,
|
|
config: {
|
|
validator: conf => !conf || validatePluginConfig(conf),
|
|
message:
|
|
'The "generateNotes" plugin, if defined, must be a single plugin definition. A plugin definition is either a string or an object with a path property.',
|
|
},
|
|
output: {
|
|
validator: output => isString(output),
|
|
message: 'The "generateNotes" plugin output must be a string.',
|
|
},
|
|
},
|
|
publish: {
|
|
default: [npm.publish, github.publish],
|
|
config: {
|
|
validator: conf => Boolean(conf) && (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
|
|
message:
|
|
'The "publish" plugin is mandatory, and must be a single or an array of plugins definition. A plugin definition is either a string or an object with a path property.',
|
|
},
|
|
},
|
|
};
|
|
|
|
const validatePluginConfig = conf => isString(conf) || isString(conf.path) || isFunction(conf);
|