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

Package detail

release-me

design4pro65MIT1.4.2

Replacement for npm version with automatic CHANGELOG generation

changelog, automatic, version, release

readme

Release Me

travis build CircleCI codecov coverage npm npm Greenkeeper badge

stop using npm version, use release-me

Automatic versioning and CHANGELOG generation.

How it works:

  1. when you're ready to release to npm:
  2. git checkout master; git pull origin master
  3. run release-me
  4. git push --follow-tags origin master; npm publish

release-me does the following:

  1. bumps the version in package.json/bower.json (based on your commit history)
  2. uses conventional-changelog (with conventional-changelog-release-me preset) to update CHANGELOG.md
  3. commits package.json (et al.) and CHANGELOG.md
  4. tags a new release

Installation

As npm run script

Install and add to devDependencies:

npm i --save-dev release-me

Add an npm run script to your package.json:

{
  "scripts": {
    "release": "release-me"
  }
}

Now you can use npm run release in place of npm version.

This has the benefit of making your repo/package more portable, so that other developers can cut releases without having to globally install release-me their machine.

As global bin

Install globally (add to your PATH):

npm i -g release-me

Now you can use release-me in place of npm version.

This has the benefit of allowing you to use release-me on any repo/package without adding a dev dependency to each one.

changelog

Change Log

1.4.2 (2017-11-30)

Full Changelog

Chores

  • package: update (42ffb65)
  • package: update codecov to version 3.0.0 (e245205)
  • package: update debug to version 3.0.0 (3eee01d)
  • package: update mocha to version 4.0.0 (1ad00c2)

Bug Fixes

  • package: update yargs to version 10.0.3 (bd0da89)
  • package: update yargs to version 9.0.1 (5c4f245)

1.4.1 (2017-07-05)

Full Changelog

Chores

1.4.0 (2017-07-05)

Full Changelog

Chores

Bug Fixes

  • package: changelog fix (541785f)
  • package: update chalk to version 2.0.0 (b6b7120)

Documentation

Tests

Features

  • package: changelog config (c736031)

1.3.1 (2017-06-13)

Full Changelog

Chores

  • package: block-scoped declarations fix (954ffb1)
  • package: block-scoped declarations fix (a508333)
  • release: 1.3.1 (f9ff94c)

Documentation

1.3.0 (2017-06-13)

Full Changelog

Chores

Features

  • package: node 4 and 5 compatibility (ee16ba8)

1.2.0 (2017-06-13)

Full Changelog

Chores

  • adapt code to updated dependencies (6bfb812)
  • package: update dependencies (69f31f1)
  • release: 1.2.0 (efe3c0b)
  • travis: whitelist greenkeeper branches (798496f)

Bug Fixes

  • package: improvments, travis-ci fix (ad05201)
  • package: Update dependencies (cd54310)

Tests

  • travis: travis-ci changes (916c85d)
  • travis: travis-ci changes (6d13bc4)
  • travis: Travis-ci changes (86f5aa4)

Features

Documentation

  • readme: add Greenkeeper badge (17b10ba)

1.1.1 (2017-06-07)

Full Changelog

Chores

  • package: dependencies update (28af8a0)
  • package: dependencies update (99d7999)
  • package: Dependencies update (f0ed2fb)
  • package: Initial commit (1c4dba8)
  • package: Name change (31c1ff6)
  • package: Promise method (ee914bc)
  • package: small changes (467e6e2)
  • package: Travis CI git push fix, changelog changes, readme update (1c54adf)
  • package: Travis CI GitHub credentials (371ff0f)
  • package: Version reset (bb37720)
  • release: 0.0.1 (1a9d287)
  • release: 0.0.2 (cd04b92)
  • release: 0.5.0 (4f2526f)
  • release: 1.1.0 (cf4af1f)
  • release: 1.1.0-dev.1 (eb9d33b)
  • release: 1.1.1 (470cd02)
  • test: Test refactor (9dcbc3a)
  • test: Travis CI, npm ignore (000b7c5)

Documentation

  • readme: Update README.md (d776a25)

Features

  • package: First stable release (d9bb84e)
  • package: New commits parser (7fa086a)
  • travis-ci: Remove release from Travis CI (a9c0a3a)

Bug Fixes

  • ci: Travis CI permission fix (ba0c5e9)

Tests