Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@hutson/conventional-changelog-config

hyper-expanse52Apache-2.0deprecated1.0.0

This package is no longer maintained. If you would like to use the functionality offered by this package, please consider publishing a fork of this package under your own npm scope.

Standard conventional-changelog configuration as used by projects maintained by Hutson Betts (@hutson).

conventional-changelog, configuration

readme

@hutson/conventional-changelog-config

Standard conventional-changelog configuration as used by projects maintained by Hutson Betts (@hutson).

Configuration package for tools within the conventional-changelog ecosystem, or those that leverage the ecosystem, such as semantic-release-gitlab, that support loading conventional-changelog presets.

Table of Contents

Features

Recommended Bump Options

  • <input checked="" disabled="" type="checkbox"> Returns level 2 for fixes, 1 for features, 0 for breaking changes and null for all other changes.

Installation

To install the @hutson/conventional-changelog-config configuration package for use in your project please run the following command:

yarn add --dev @hutson/conventional-changelog-config

Usage

Each tool capable of using a conventional-changelog configuration package has its own API for consuming the configuration. Please refer to those tools for the appropriate documentation.

However, as an example, if you are using semantic-release-gitlab or semantic-release-github, you can pass this configuration package to those tools like so:

$(yarn bin)/semantic-release-gitlab --preset @hutson/config

Security Disclosure Policy

To report a security vulnerability in this package, or one of it's dependencies, please use the Tidelift security contact page. Tidelift will coordinate the process to address the vulnerability and disclose the incident to our users.

Professional Support

Professional support for @hutson/conventional-changelog-config is available with a Tidelift Subscription.

Tidelift helps make open source sustainable for maintainers while giving companies assurances about security, maintenance, and licensing for their dependencies.

Debugging

To assist users of @hutson/conventional-changelog-config with debugging the behavior of this module we use the debug utility package to print information 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 a tool that invokes this module:

DEBUG=@hutson/conventional-changelog-config [CONSUMING TOOL]

On the Windows command line you may do:

set DEBUG=@hutson/conventional-changelog-config
[CONSUMING TOOL]

Node Support Policy

We only support Long-Term Support 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 to see how you may contribute to this project.