https://github.com/evelynhathaway/semantic-release-fail-on-major-bump

💥⛔ Semantic release plugin that prevents publishing major version bumps
https://github.com/evelynhathaway/semantic-release-fail-on-major-bump

ci semantic-release semantic-release-plugin

Last synced: 4 days ago
JSON representation

💥⛔ Semantic release plugin that prevents publishing major version bumps

• Host: GitHub
• URL: https://github.com/evelynhathaway/semantic-release-fail-on-major-bump
• Owner: evelynhathaway
• License: mit
• Created: 2021-05-30T19:11:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T02:27:46.000Z (almost 2 years ago)
• Last Synced: 2024-12-17T07:25:43.114Z (5 days ago)
• Topics: ci, semantic-release, semantic-release-plugin
• Language: JavaScript
• Homepage: https://npmjs.com/package/semantic-release-fail-on-major-bump
• Size: 1.08 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        




# Semantic Release Fail on Major Bump

**Semantic release plugin that prevents publishing major version bumps**

[![npm version](https://badgen.net/npm/v/semantic-release-fail-on-major-bump?icon=npm)](https://www.npmjs.com/package/semantic-release-fail-on-major-bump)

[![check status](https://badgen.net/github/checks/evelynhathaway/semantic-release-fail-on-major-bump/main?icon=github)](https://github.com/evelynhathaway/semantic-release-fail-on-major-bump/actions)

[![license: MIT](https://badgen.net/badge/license/MIT/blue)](/LICENSE)



## 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

```bash

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

```

## Usage

In your [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration), add `semantic-release-fail-on-major-bump`.

**`.releaserc`**

```json

{

  "plugins": [

    [

      "semantic-release-fail-on-major-bump",

      "@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"]

        }

      }

    ]

  ]

}

```

## License

Copyright Evelyn Hathaway, [MIT License](/LICENSE)