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

semantic-release plugin to analyze commits with conventional-changelog


Version published
Maintainers
4
Created

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

Keywords

FAQs

Package last updated on 31 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

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