recommended-bump

Calculates recommended bump (next semver version) based on given array of commit messages following Conventional Commits specification

Please consider following this project's author, Charlike Mike Reagent, and ⭐ the project to show your ❤️ and support.

If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Project is semantically & automatically released on CircleCI with new-release and its New Release GitHub App.

Table of Contents

• Install
• API
  • src/index.js
    • recommendedBump
• See Also
• Contributing
  • Follow the Guidelines
  • Support the project
  • OPEN Open Source
  • Wonderful Contributors
• License

(TOC generated by verb using markdown-toc)

Install

This project requires Node.js ^8.10.0 || >=10.13.0. Install it using yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.

$ yarn add recommended-bump

API

Generated using docks.

src/index.js

recommendedBump

Calculates recommended bump (next version), based on given commits. It always returns an object. If no commits are given it is { increment: false }. Otherwise it may contain patch, minor, or major properties which are of Array<Commit> type, based on parse-commit-message.

ProTip: Use result[result.increment] to get most meanigful result.

Each item passed as commits is validated against the Convetional Comits Specification and using parse-commit-message. Commits can be string, array of commit message strings, array of objects (of type Commit as defined) or mix of previous posibilities.

See the tests and examples for more clarity.

Params

• commits {string||} commit messages one of string, Array<string> or Array<Commit>
• [options] {object} pass additional options.plugins to be passed to parse-commit-message

Returns

• object result like { increment: boolean | string, patch?, minor?, major? }

Examples

import recommendedBump from 'recommended-bump';

const commits = [
  'chore: foo bar baz',
  `fix(cli): some bugfix msg here

Some awesome body.

Great footer and GPG sign off, yeah!
Signed-off-by: Awesome footer <[email protected]>`
  ];

const { increment, isBreaking, patch } = recommendedBump(commits);

console.log(isBreaking); // => false
console.log(increment); // => 'patch'
console.log(patch);
// => [{ header: { type, scope, subject }, body, footer }, { ... }]
console.log(patch[0].header.type); // => 'fix'
console.log(patch[0].header.scope); // => 'cli'
console.log(patch[0].header.subject); // => 'some bugfix msg here'
console.log(patch[0].body); // => 'Some awesome body.'
console.log(patch[0].footer);
// => 'Great footer and GPG sign off, yeah!\nSigned-off-by: Awesome footer <[email protected]>'

import { parse } from 'parse-commit-message';
import recommendedBump from 'recommended-bump';

const commitOne = parse('fix: foo bar');
const commitTwo = parse('feat: some feature subject');

const result = recommendedBump([commitOne, commitTwo]);
console.log(result.increment); // => 'minor'
console.log(result.isBreaking); // => false
console.log(result.minor); // => [{ ... }]

back to top

See Also

Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!

• @tunnckocore/config: All the configs for all the tools, in one place | homepage
• @tunnckocore/create-project: Create and scaffold a new project, its GitHub repository and contents | homepage
• @tunnckocore/execa: Thin layer on top of execa that allows executing multiple commands… more | homepage
• @tunnckocore/package-json: Simple and fast getting of latest package.json metadata for a npm… more | homepage
• @tunnckocore/scripts: Universal and minimalist scripts & tasks runner. | homepage
• @tunnckocore/update: Update to latest project files and templates, based on charlike scaffolder | homepage
• asia: Blazingly fast, magical and minimalist testing framework, for Today and Tomorrow | homepage
• charlike: Small, fast and streaming project scaffolder with support for hundreds of… more | homepage
• docks: Extensible system for parsing and generating documentation. It just freaking works! | homepage
• gitcommit: Lightweight and joyful git commit replacement. Conventional Commits compliant. | homepage

back to top

Contributing

Follow the Guidelines

Please read the Contributing Guide and Code of Conduct documents for advices.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Support the project

Become a Partner or Sponsor? 💵 Check the Partner, Sponsor or Omega-level tiers! 🎉 You can get your company logo, link & name on this file. It's also rendered on package page in npmjs.com and yarnpkg.com sites too! 🚀

Not financial support? Okey! Pull requests, stars and all kind of contributions are always welcome. ✨

OPEN Open Source

This project is following OPEN Open Source model

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is built on collective efforts and it's not strongly guarded by its founders.

There are a few basic ground-rules for its contributors

1. Any significant modifications must be subject to a pull request to get feedback from other contributors.
2. Pull requests to get feedback are encouraged for any other trivial contributions, but are not required.
3. Contributors should attempt to adhere to the prevailing code-style and development workflow.

Wonderful Contributors

Thanks to the hard work of these wonderful people this project is alive! It follows the all-contributors specification.
Don't hesitate to add yourself to that list if you have made any contribution! ;) See how, here.

Charlike Mike Reagent 💻 📖 💬 👀 🔍

Consider showing your support to them. 💖

License

Copyright (c) 2018-present, Charlike Mike Reagent <[email protected]> & contributors.
Released under the Apache-2.0 License.