Package Exports

semantic-release-commits-lint
semantic-release-commits-lint/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (semantic-release-commits-lint) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

semantic-release-commits-lint

semantic-release plugin for analyzing commit messages by commitlint

Step	Description
`analyzeCommits`	Analyzing commit messages by commitlint.

Install

npm install semantic-release-commits-lint -D

Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "semantic-release-commits-lint"
  ]
}

Configuration

Options

Options	Description	Default
`commitlintFile`	File path of the commitlint config.	-
`commitlintConfig`	Commitlint config as object.	-

Notes: For the plugin to work correctly, you need to configure commitlint config

Example configuration

Configuration globaly in project

Install @commitlint/config-conventional if need.

npm install @commitlint/config-conventional -D

Add commitlint config file in project

.commitlintrc.json

{
  "extends": ["@commitlint/config-conventional"],
  "rules": {
    "type-case": [2, "always", ["pascal-case"]]
  }
}

Configuration semantic-release

.releaserc

{
  "plugins": [
    "semantic-release-commits-lint"
  ]
}

Configuration by `commitlintFile` option

Install @commitlint/config-conventional if need.

npm install @commitlint/config-conventional -D

Add commitlint config file in project

.commitlintrc-for-semantic-release.json

{
  "extends": ["@commitlint/config-conventional"],
  "rules": {
    "type-case": [2, "always", ["pascal-case"]]
  }
}

Configuration semantic-release

.releaserc

{
  "plugins": [
    [
      "semantic-release-commits-lint",
      {
        "commitlintFile": ".commitlintrc-for-semantic-release.json"
      }
    ]
  ]
}

Configuration by `commitlintConfig` option

Install @commitlint/config-conventional if need.

npm install @commitlint/config-conventional -D

Configuration semantic-release

.releaserc

{
  "plugins": [
    [
      "semantic-release-commits-lint",
      {
        "commitlintConfig": {
          "extends": ["@commitlint/config-conventional"],
          "rules": {
            "type-case": [2, "always", ["pascal-case"]]
          }
        }
      }
    ]
  ]
}