conventional-recommended-bump
Advanced tools
conventional-recommended-bump - npm Package Compare versions
Comparing version 3.0.0 to 4.0.0
@@ -6,2 +6,25 @@ # Change Log | ||
| <a name="4.0.0"></a> | ||
| # [4.0.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@3.0.0...conventional-recommended-bump@4.0.0) (2018-06-06) | ||
| ### Features | ||
| * re-use parser options within each preset ([#335](https://github.com/conventional-changelog/conventional-changelog/issues/335)) ([d3eaacf](https://github.com/conventional-changelog/conventional-changelog/commit/d3eaacf)), closes [#241](https://github.com/conventional-changelog/conventional-changelog/issues/241) | ||
| ### BREAKING CHANGES | ||
| * Re-use parser options object between components of a preset. For some | ||
| presets this may change the behavior of `conventional-recommended-bump` | ||
| as the parser options object for the `conventional-recommended-bump` options | ||
| within a preset were different than the parser options object for the | ||
| `conventional-changelog` options within a preset. | ||
| If you are not using `conventional-recommended-bump`, then this is | ||
| **not** a breaking change for you. | ||
| <a name="3.0.0"></a> | ||
@@ -8,0 +31,0 @@ # [3.0.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@2.0.9...conventional-recommended-bump@3.0.0) (2018-05-29) |
| { | ||
| "name": "conventional-recommended-bump", | ||
| "version": "3.0.0", | ||
| "version": "4.0.0", | ||
| "description": "Get a recommended version bump based on conventional commits", | ||
@@ -5,0 +5,0 @@ "bugs": { |
@@ -1,2 +0,2 @@ | ||
| # [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverall-image]][coverall-url] | ||
| # conventional-recommended-bump | ||
@@ -7,2 +7,23 @@ > Get a recommended version bump based on conventional commits. | ||
| ## Table of Contents | ||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [API](#api) | ||
| - [options](#options) | ||
| - [ignoreReverted](#ignorereverted) | ||
| - [preset](#preset) | ||
| - [config](#config) | ||
| - [whatBump](#whatbump) | ||
| - [tagPrefix](#tagprefix) | ||
| - [lernaPackage](#lernapackage) | ||
| - [parserOpts](#parseropts) | ||
| - [callback](#callback) | ||
| - [License](#license) | ||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
| ## Install | ||
@@ -120,13 +141,39 @@ | ||
| ## Debugging | ||
| To assist users of `conventional-recommended-bump` with debugging the behavior of this module we use the [debug](https://www.npmjs.com/package/debug) utility package to print information about the release process to the console. To enable debug message printing, the environment variable `DEBUG`, which is the variable used by the `debug` package, must be set to a value configured by the package containing the debug messages to be printed. | ||
| To print debug messages on a unix system set the environment variable `DEBUG` with the name of this package prior to executing `conventional-recommended-bump`: | ||
| ```bash | ||
| DEBUG=conventional-recommended-bump conventional-recommended-bump | ||
| ``` | ||
| On the Windows command line you may do: | ||
| ```bash | ||
| set DEBUG=conventional-recommended-bump | ||
| conventional-recommended-bump | ||
| ``` | ||
| ## Node Support Policy | ||
| We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node. | ||
| We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment. | ||
| It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support. | ||
| As each Node LTS version reaches its end-of-life we will remove that version from the `node` `engines` property of our package's `package.json` file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed. | ||
| We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called _current_. | ||
| JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our `node` `engines` property. If you encounter issues installing this package, please report the issue to your package manager. | ||
| ## Contributing | ||
| Please read our [contributing guide](https://github.com/conventional-changelog/conventional-changelog/blob/master/CONTRIBUTING.md) to see how you may contribute to this project. | ||
| ## License | ||
| MIT © [Steve Mao](https://github.com/stevemao) | ||
| [npm-image]: https://badge.fury.io/js/conventional-recommended-bump.svg | ||
| [npm-url]: https://npmjs.org/package/conventional-recommended-bump | ||
| [travis-image]: https://travis-ci.org/conventional-changelog/conventional-recommended-bump.svg?branch=master | ||
| [travis-url]: https://travis-ci.org/conventional-changelog/conventional-recommended-bump | ||
| [daviddm-image]: https://david-dm.org/conventional-changelog/conventional-recommended-bump.svg?theme=shields.io | ||
| [daviddm-url]: https://david-dm.org/conventional-changelog/conventional-recommended-bump | ||
| [coverall-image]: https://coveralls.io/repos/conventional-changelog/conventional-recommended-bump/badge.svg | ||
| [coverall-url]: https://coveralls.io/r/conventional-changelog/conventional-recommended-bump |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by15.83%
25214
- Number of lines in readme file
- increased by35.88%
178
No dependency changes