Socket
Socket
Sign inDemoInstall

@semantic-release/commit-analyzer

Package Overview
Dependencies
Maintainers
4
Versions
60
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@semantic-release/commit-analyzer - npm Package Compare versions

Comparing version 3.0.6 to 3.0.7

8

package.json
{
"name": "@semantic-release/commit-analyzer",
"description": "Customizable commit-analyzer plugin for semantic-release",
"version": "3.0.6",
"version": "3.0.7",
"author": "Pierre Vanduynslager",

@@ -23,4 +23,2 @@ "bugs": {

"devDependencies": {
"@commitlint/cli": "^3.1.3",
"@commitlint/config-angular": "^3.1.1",
"ava": "^0.22.0",

@@ -43,3 +41,2 @@ "codecov": "^2.3.0",

"eslint-plugin-standard": "^3.0.1",
"husky": "^0.14.3",
"nyc": "^11.1.0",

@@ -115,6 +112,3 @@ "prettier": "^1.7.2",

"codecov": "codecov -f coverage/coverage-final.json",
"commitmsg": "commitlint -e",
"lint": "eslint lib test",
"precommit": "npm run lint",
"prepush": "ava -v",
"pretest": "npm run clean && npm run lint",

@@ -121,0 +115,0 @@ "semantic-release": "semantic-release pre && npm publish && semantic-release post",

12

README.md

@@ -18,5 +18,5 @@ # **commit-analyzer**

By default `commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md).
By default `commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md) and the [default rules](lib/default/release-rules.js) for release.
Additionnal options can be set within the plugin definition in `package.json` to use a different commit format and to customize it:
Additional options can be set within the plugin definition in `package.json` to use a different commit format and to customize it:

@@ -52,2 +52,4 @@ ```json

Release rules are used when deciding if the commits since the last release warrant a new release. If you define custom release rules the [default rules](lib/default/release-rules.js) will be used if nothing matched.
#### Rules definition

@@ -82,3 +84,3 @@ This is an `Array` of rule objects. A rule object has a `release` property and 1 or more criteria.

If a commit doesn't match any rule in `releaseRules` it will be evaluated agaisnt the [default release rules](lib/default/release-rules.js).
If a commit doesn't match any rule in `releaseRules` it will be evaluated against the [default release rules](lib/default/release-rules.js).

@@ -102,3 +104,3 @@ With the previous example:

If there is multiple commits that match one or more rules, the one with the highest realease type will determine the global release type.
If there is multiple commits that match one or more rules, the one with the highest release type will determine the global release type.

@@ -113,3 +115,3 @@ Considering the following commits:

The properties to set in the rules will depends on the commit style choosen. For example [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L9-L13) use the commit properties `type`, `scope` and `subject` but [conventional-changelog-eslint](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-eslint/index.js#L9-L12) uses `tag` and `message`.
The properties to set in the rules will depends on the commit style chosen. For example [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L9-L13) use the commit properties `type`, `scope` and `subject` but [conventional-changelog-eslint](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-eslint/index.js#L9-L12) uses `tag` and `message`.

@@ -116,0 +118,0 @@ For example with `eslint` preset:

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc