freeform-semantic-commit-analyzer

derive next semantic version from commits, covering most commit messages types


Keywords
semantic-release, author, automation, changelog, module, package, publish, release, semver, version
License
MIT
Install
npm install freeform-semantic-commit-analyzer@1.1.2

Documentation

freeform-semantic-commit-analyzer

npm version Build Status Coverage Status Dependency Status devDependency Status semantic-release

An analyzeCommits plugin for semantic-release covering most commit types.

Major Releases

SEE: https://github.com/semantic-release/semantic-release#major-breaking-release

  • Breaking Changes

Minor Releases

  • feat

SEE: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#type

Patch Releases

  • chore
  • docs
  • fix
  • perf
  • refactor
  • revert
  • unstructured commits

This fork

Changes list compared to https://github.com/semantic-release/commit-analyzer:

  • unstructured commits yield in patch versions
  • most other commit types yield in patch versions
  • you can disable some version change types by specifying allowed version types in package.json like this:
  "publishConfig": {
    "tag": "1x"
  },
  "release": {
    "branch": "1x",
    "analyzeCommits": {
        "path": "./node_modules/freeform-semantic-commit-analyzer/dist/index.js",
        "allowed": ["patch", "minor"],
        "fallback": "minor"
    }
  }

Here, only 'patch' and 'minor' version changes are allowed - this is a package for legacy 1.x branch and we don't want it to jump out of 1.x versions range ocasionally. Default fallback version type is 'patch'.