semantic-release-fail-on-major-bump v1.0.2

Semantic Release Fail on Major Bump

Semantic release plugin that prevents publishing major version bumps

Description

If you need your pipelines to fail if a major or breaking change release will be created with semantic-release, drop this plugin into your config.

Installation

npm install --save-dev semantic-release-fail-on-major-bump

Usage

In your semantic-release configuration file, add semantic-release-fail-on-major-bump.

release.config.mjs

export default {
	plugins: [
		// Add this line
		"semantic-release-fail-on-major-bump",
		// Example semantic-release commit-analyzer config below...
		[
			"@semantic-release/commit-analyzer",
			{
				"preset": "angular",
				"releaseRules": [
					{"type": "docs", "scope": "README", "release": "patch"},
					{"type": "refactor", "release": "patch"},
					{"type": "style", "release": "patch"},
				],
				"parserOpts": {
					"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"],
				},
			},
		],
	],
};

Development

Testing

Make a either a Breaking: or non-breaking typed commit and then see if the error was thrown if expected while running a dummy dry-run release.

npm run test-release

License

Copyright Evelyn Hathaway, MIT License