version-changelog

Add a version & URL to your changelog

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
version-changelog
3.1.16 years ago8 years agoMinified + gzip package size for version-changelog in KB

Readme

Version Changelog CircleCI
Add a version & URL to your CHANGELOG.md.
Goes great with changelog-verify. Add this to your package.json:
{
  "scripts": {
    "version": "version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"
  }
}

Now whenever you execute npm version (or np), your CHANGELOG.md will be given the correct version info, checked for validity (did you forget to add changelog notes?) then added to the release commit.

Usage

Given the following ./CHANGELOG.md
# Changelog

## [Unreleased][]

- These aren’t the droids you’re looking for

## [1.0.0][] - 2016-10-11

- Reticulated the splines

And package.json
{
  "version": "2.0.0"
}

Executing the versioning script
version-changelog ./CHANGELOG.md

Will return success (0), and update CHANGELOG.md to:
# Changelog

## [Unreleased][]

## [2.0.0][] - <today's date>

- These aren’t the droids you’re looking for

## [1.0.0][] - 2016-10-11

- Reticulated the splines

See the tests for more usage examples.

Changelog format

This tool assumes a particular format for your changelog, keeping in style with http://keepachangelog.com:
<some intro text>
## [Unreleased][]
<optional unreleased notes>
## [<version number>][]
<required release notes>

Where <version number> is the more recently previous release of this module.

Options

The cli takes two optional parameters:
  • the changelog filename
  • the remote code repository (github, gitlab, or bitbucket - used to
generate URL's for versions). Default: github
changelog-verify [filename] [--remote=bitbucket|gitlab|github]

filename can be a path relative to the current working directory, or an absolute path.