Generate changelogs and release notes from a project's commit messages and metadata.

License: ISC

Language: JavaScript

Keywords: changelog, git, history, metadata, tag

Conventional Changelog

Build Status Coverage Status Standard Version community slack

Having problems? want to contribute? join our community slack.

Generate a CHANGELOG from git metadata

About this Repo

The conventional-changelog repo is managed as a monorepo; it's composed of many npm packages.

The original conventional-changelog/conventional-changelog API repo can be found in packages/conventional-changelog.

Getting started

It's recommended you use the high level standard-version library, which is a drop-in replacement for npm's version command, handling automated version bumping, tagging and CHANGELOG generation.

Alternatively, if you'd like to move towards completely automating your release process as an output from CI/CD, consider using semantic-release.

You can also use one of the plugins if you are already using the tool:

Plugins Supporting Conventional Changelog

Modules Important to Conventional Changelog Ecosystem

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.

Project Statistics

Sourcerank 21
Repository Size 3.64 MB
Stars 3,859
Forks 394
Watchers 35
Open issues 98
Dependencies 1,538
Contributors 95
Tags 746
Last updated
Last pushed

Top Contributors See all

Steve Mao Hutson Betts Andrew Joslin Benjamin E. Coe Renovate Bot tommywo renovate[bot] Mario Nebl Tapani Moilanen Nicolas Lunet Thomas Vantuycom Gustaf Dalemar Yoann Moinet Pierre Vanduynslager Stéphane Bachelier The Gitter Badger Ray Benefield Daniel Stockman Ingmar Hergst Joe Bottigliero

Packages Referencing this Repo

Generate a changelog from git metadata
Latest release 2.0.30 - Updated - 3.86K stars
Generate a changelog from git metadata
Latest release 3.1.17 - Updated - 3.86K stars
Generate a changelog using conventional-changelog
Latest release 2.0.28 - Updated - 3.86K stars
conventional-changelog core
Latest release 4.1.3 - Updated - 3.86K stars
Generate a changelog from git metadata with Angular commit convention
Latest release 2.0.20 - Updated - 3.86K stars
conventional-changelog preset
Latest release 4.2.3 - Updated - 3.86K stars
conventional-changelog CodeMirror preset
Latest release 2.0.3 - Updated - 3.86K stars
conventional-changelog eslint preset
Latest release 3.0.4 - Updated - 3.86K stars
conventional-changelog jquery preset
Latest release 3.0.6 - Updated - 3.86K stars
Filter out reverted commits parsed by conventional-commits-parser
Latest release 2.0.2 - Updated - 3.86K stars
Configuration preset loader for `conventional-changelog`.
Latest release 2.3.0 - Updated - 3.86K stars
conventional-changelog ember preset
Latest release 2.0.4 - Updated - 3.86K stars
conventional-changelog atom preset
Latest release 2.0.3 - Updated - 3.86K stars
conventional-changelog jshint preset
Latest release 2.0.3 - Updated - 3.86K stars
conventional-changelog angular preset
Latest release 5.0.6 - Updated - 3.86K stars
Write logs based on conventional commits and templates
Latest release 4.0.11 - Updated - 3.86K stars
Get all git semver tags of your repository in reverse chronological order
Latest release 3.0.1 - Updated - 3.86K stars
Get a recommended version bump based on conventional commits
Latest release 6.0.5 - Updated - 3.86K stars
Parse raw conventional commits
Latest release 3.0.8 - Updated - 3.86K stars
Get raw git commits out of your repository using git-log(1)
Latest release 2.0.3 - Updated - 3.86K stars

Recent Tags See all

standard-changelog@2.0.20 November 27, 2019
gulp-conventional-changelog@2.0.28 November 27, 2019
conventional-changelog-core@4.1.3 November 27, 2019
conventional-changelog-cli@2.0.30 November 27, 2019
conventional-changelog@3.1.17 November 27, 2019
standard-changelog@2.0.19 November 21, 2019
gulp-conventional-changelog@2.0.27 November 21, 2019
conventional-changelog-core@4.1.2 November 21, 2019
conventional-changelog-cli@2.0.29 November 21, 2019
conventional-changelog@3.1.16 November 21, 2019
standard-changelog@2.0.18 November 14, 2019
gulp-conventional-changelog@2.0.26 November 14, 2019
git-semver-tags@3.0.1 November 14, 2019
git-raw-commits@2.0.3 November 14, 2019
conventional-recommended-bump@6.0.5 November 14, 2019

Something wrong with this page? Make a suggestion

Last synced: 2019-11-21 07:39:38 UTC

Login to resync this repository