@studio/changes

📦 Generate a changelog as part of the npm version command

<img src="https://img.shields.io/npm/v/@studio/changes.svg" alt="npm Version">

<img src="https://img.shields.io/:semver-%E2%9C%93-blue.svg" alt="SemVer">

<img src="https://github.com/mantoni/eslint_d.js/workflows/Build/badge.svg" alt="Build Status">

<img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" alt="License">

Usage

• Use npm version [patch|minor|major] to create a release
• Your editor will open with a generated CHANGES.md file
• When you're done writing the release notes, save and close the editor to

• To abort the release, remove the heading with the new version number

Install

❯ npm install @studio/changes --save-dev

Configure

❯ npx changes --init

{
  "scripts": {
    "preversion": "npm test",
    "version": "changes",
    "postversion": "git push --follow-tags && npm publish"
  }
}

Options

• --help, -h: Display a help message.
• --commits, -c: Generate links to commits using the given URL as base. If

• --footer: Generate a footer with the git author and release date. The

• --file, -f: Specify the name of the changelog file. Defaults to

• --init: Add version lifecycle scripts to package.json. Can be combined

• --tag: Use a custom git tag, supports simple replacement of package.json

Preview next release

❯ npx changes

License

Made with ❤️ on 🌍