https://github.com/web-mech/bump-suggest

Suggest the next version of a project based on commits and current version
https://github.com/web-mech/bump-suggest

Last synced: about 2 months ago
JSON representation

Suggest the next version of a project based on commits and current version

• Host: GitHub
• URL: https://github.com/web-mech/bump-suggest
• Owner: web-mech
• License: mit
• Created: 2017-04-14T21:01:01.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-17T18:57:16.000Z (about 8 years ago)
• Last Synced: 2025-03-06T09:18:06.601Z (3 months ago)
• Language: JavaScript
• Size: 20.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bump-suggest

Suggest the next version of a project based on commits and a given version

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

## Inspiration

 - [Conventional Commits](https://conventionalcommits.org/ "Conventional Commits")

 - [conventional-recommended-bump](https://github.com/conventional-changelog-archived-repos/conventional-recommended-bump "conventional-recommended-bump")

 - [standard-version](https://github.com/conventional-changelog/standard-version "standard-version")

 - [conventional-commits-parser](https://github.com/conventional-changelog-archived-repos/conventional-commits-parser "conventional-commits-parser")

 - [commit-analyzer](https://github.com/semantic-release/commit-analyzer "commit-analyzer")

 - The simple need to be able to tell the next version based on commits and a previous version.

## Syntax

```

bumpSuggest(commits, base[, parserOpts])

```

### Parameters

- commits \[Array\\] - an array of commit messages

- base \ - base version to suggest from

- parserOpts {Object} - [parser optons](https://github.com/conventional-changelog-archived-repos/conventional-commits-parser#options "Conventional Parser Options")

## Example Usage

```

const bumpSuggest = require('bump-suggest');

bumpSuggest(['fix(everything): Some test commit message'], '0.1.0'); //0.1.1

```

## Testing & Contributing

```

NODE_ENV=development npm install

npm test

```