semantic-release-commits-lint

semantic-release plugin for analyzing commit messages by commitlint


| Step | Description |
| ---------------- |--------------------------------------------------------------------------------------------------|
| analyzeCommits | Analyzing commit messages by commitlint. |

Install

``sh
npm install semantic-release-commits-lint -D
`

Usage

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

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

Configuration

$3

| 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

$3

#### Configuration globaly in project

1. Install @commitlint/config-conventional if need.

`sh
npm install @commitlint/config-conventional -D
`

2. Add commitlint config file in project

.commitlintrc.json

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

3. Configuration semantic-release

.releaserc

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

#### Configuration by commitlintFile option

1. Install @commitlint/config-conventional if need.

`sh
npm install @commitlint/config-conventional -D
`

2. Add commitlint config file in project

.commitlintrc-for-semantic-release.json

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

3. Configuration semantic-release

.releaserc

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

#### Configuration by commitlintConfig option

1. Install @commitlint/config-conventional if need.

`sh
npm install @commitlint/config-conventional -D
`

2. Configuration semantic-release

.releaserc

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