8d575654c2
- Remove `@semantic-release/condition-travis` from the default plugins - Verify the current branch in the core - Verify the build is not triggered by a PR in the core - Run in dry-run mode if not triggered on CI - Dry-run mode runs the `verifyConditions` plugins, allowing to detect configuration error locally - Return without error when no version has to be released due to no changes - Return without error if the build is triggered from a PR - Return without error if the current branch is not the configured branch - CLI return with exit code 1 if there is a `semanticReleaseError`, allowing to fail builds in case of config error, missing token etc... BREAKING CHANGE: `semantic-release` doesn't make sure it runs only on one Travis job anymore. The CI configuration has to be done such that `semantic-release` - runs only once per build - runs only after all tests are successful on every jobs of the build - runs on Node >=8 This can easily be done with [travis-deploy-once](https://github.com/semantic-release/travis-deploy-once). Migration Guide Modify your `.travis.yml` to use `travis-deploy-once`. Replace: ```yaml after_success: - npm run semantic-release ``` by: Replace ```yaml after_success: - npm install -g travis-deploy-once@4 - travis-deploy-once "npm run semantic-release" ```
73 lines
3.3 KiB
JavaScript
73 lines
3.3 KiB
JavaScript
const {isString, isObject, isFunction, isArray} = require('lodash');
|
|
const semver = require('semver');
|
|
|
|
const RELEASE_TYPE = ['major', 'premajor', 'minor', 'preminor', 'patch', 'prepatch', 'prerelease'];
|
|
const validatePluginConfig = conf => isString(conf) || isString(conf.path) || isFunction(conf);
|
|
|
|
module.exports = {
|
|
verifyConditions: {
|
|
default: ['@semantic-release/npm', '@semantic-release/github'],
|
|
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: '@semantic-release/npm',
|
|
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))) && Boolean(output.gitHead)),
|
|
message:
|
|
'The "getLastRelease" plugin output if defined, must be an object with a valid semver version in the "version" property and the corresponding git reference in "gitHead" property.',
|
|
},
|
|
},
|
|
analyzeCommits: {
|
|
default: '@semantic-release/commit-analyzer',
|
|
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, if defined, must be 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: '@semantic-release/release-notes-generator',
|
|
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 => !output || isString(output),
|
|
message: 'The "generateNotes" plugin output, if defined, must be a string.',
|
|
},
|
|
},
|
|
publish: {
|
|
default: ['@semantic-release/npm', '@semantic-release/github'],
|
|
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.',
|
|
},
|
|
},
|
|
};
|