What is conventional-recommended-bump?
The conventional-recommended-bump npm package is a tool that analyzes conventional-style commit messages (like those used by AngularJS) to determine the type of version bump (major, minor, or patch) that should be recommended based on the changes made. It is often used in automated versioning and release workflows to ensure semantic versioning practices are followed.
What are conventional-recommended-bump's main functionalities?
Determining the type of version bump
This feature allows you to determine whether your next release should be a major, minor, or patch version. The code sample shows how to use the package with the Angular preset to get a recommendation.
const conventionalRecommendedBump = require('conventional-recommended-bump');
conventionalRecommendedBump({
preset: 'angular'
}, (error, recommendation) => {
console.log(recommendation.releaseType);
});
Customizable preset options
This feature allows you to customize the preset options for analyzing commit messages. The code sample demonstrates how to specify a custom header pattern and correspondence for the Angular preset.
const conventionalRecommendedBump = require('conventional-recommended-bump');
conventionalRecommendedBump({
preset: 'angular',
config: {
headerPattern: /^\[(.*)\] (.*)$/,
headerCorrespondence: ['type', 'subject']
}
}, (error, recommendation) => {
console.log(recommendation.releaseType);
});
Using a custom parser
This feature allows you to use a custom parser for commit messages. The code sample shows how to pass custom parser options to the package.
const conventionalRecommendedBump = require('conventional-recommended-bump');
const customParserOpts = require('./custom-parser-opts');
conventionalRecommendedBump({
parserOpts: customParserOpts
}, (error, recommendation) => {
console.log(recommendation.releaseType);
});
Other packages similar to conventional-recommended-bump
semantic-release
semantic-release is an npm package that automates the versioning and package publishing process based on semantic versioning and conventional commit messages. It is more comprehensive than conventional-recommended-bump as it includes the entire release workflow, not just the recommendation for version bumps.
standard-version
standard-version is an automated versioning tool that adheres to Semantic Versioning and uses conventional commit messages to determine version bumps. It is similar to conventional-recommended-bump but also handles the generation of changelogs and tagging of releases.
release-it
release-it is a generic CLI tool for automating versioning and package publishing. It supports conventional commits and can determine version bumps, but it also includes a wide range of release-related tasks, making it more versatile than conventional-recommended-bump.
Get a recommended version bump based on conventional commits
Got the idea from https://github.com/ajoslin/conventional-changelog/pull/29
Install
$ npm install --save conventional-recommended-bump
Usage
var conventionalRecommendedBump = require('conventional-recommended-bump');
conventionalRecommendedBump({
conventionalRecommendedBump({
preset: 'angular'
}, function(err, releaseAs) {
console.log(releaseAs);
});
});
$ npm install --global conventional-recommended-bump
$ conventional-recommended-bump --help
Get a recommended version bump based on conventional commits
Usage
conventional-recommended-bump
Example
conventional-recommended-bump
Options
-p, --preset Name of the preset you want to use
-h, --header-pattern Regex to match header pattern
-c, --header-correspondence Comma separated parts used to define what capturing group of headerPattern captures what
-r, --reference-actions Comma separated keywords that used to reference issues
-i, --issue-prefixes Comma separated prefixes of an issue
-n, --note-keywords Comma separated keywords for important notes
-f, --field-pattern Regex to match other fields
-v, --verbose Verbose output
API
conventionalRecommendedBump(options, [parserOpts], [callback])
options
ignoreReverted
Type: boolean
Default: true
If true
, reverted commits will be ignored.
preset
Type: string
Possible values: 'angular'
A set of options of a popular project.
whatBump
Type: function
A function that takes parsed commits as argument and returns a number indicating what bump it should be.
whatBump(commits)
####### commits
Type: array
An array of parsed commits. The commits are from last semver tag to HEAD
and is parsed by conventional-commits-parser.
If it returns 0
it will be a major
bump. If 1
, minor
bump. If 2
, patch
.
parserOpts
See the conventional-commits-parser docs.
callback
Type: function
callback(error, releaseAs)
releaseAs
Type: string
Possible values: 'major'
, 'minor'
and 'patch'
The value of what it should release as. If it cannot decide this is an empty string.
Related
License
MIT © Steve Mao