@semantic-release/commit-analyzer

What is @semantic-release/commit-analyzer?

The @semantic-release/commit-analyzer npm package is a plugin for the semantic-release ecosystem that analyzes commits to determine the type of version bump (if any) that should be applied according to semantic versioning principles. It uses commit messages to figure out the next semantic version based on the changes made.

What are @semantic-release/commit-analyzer's main functionalities?

Analyze Commits

This feature analyzes an array of commit messages and determines the type of version bump needed. In the code sample, a commit message is analyzed, and the callback function logs the release type, which in this case is 'patch'.

const analyzeCommits = require('@semantic-release/commit-analyzer');

analyzeCommits({}, {commits: [{message: 'fix(pencil): stop graphite breaking when too much pressure applied'}]}, (err, type) => {
  console.log(type); // prints 'patch'
});

Configuration

This feature allows users to configure the commit analyzer by specifying custom release rules and parser options. The code sample shows a configuration object that defines custom rules for determining the release type based on commit types and scopes.

{
  "releaseRules": [
    {"type": "feat", "release": "minor"},
    {"type": "fix", "release": "patch"},
    {"type": "perf", "release": "patch"},
    {"scope": "no-release", "release": false}
  ],
  "parserOpts": {
    "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
  }
}

Other packages similar to @semantic-release/commit-analyzer

conventional-changelog

Conventional Changelog is a set of tools for parsing conventional commit messages. It's similar to @semantic-release/commit-analyzer in that it can be used to determine version bumps and generate changelogs, but it provides a more comprehensive set of tools for generating changelogs from git metadata.

commitlint

Commitlint checks if your commit messages meet the conventional commit format. While it doesn't directly analyze commits to determine version bumps, it ensures that commit messages are formatted in a way that tools like @semantic-release/commit-analyzer can accurately analyze them.

standard-version

Standard Version is a utility for versioning using semver and CHANGELOG generation powered by Conventional Commits. It automates the versioning and changelog process but does not provide the same plugin-based architecture as @semantic-release/commit-analyzer.

README

semantic-release commit-analyzer