@faustt/release

Simple release management.

Introduction

This command line tool provides a unified release process for Node.js packages.

Features

Semantic release

The tool bumps your version according to semantic release guidelines. Your commits are analyzed using an extended conventional commit syntax to determine the version bump. See anaylzeCommits.ts for more information.

To specify a custom initial version (instead of 0.1.0), specify it inside your package.json:

{
  "release": {
    "initialVersion": "2.0.0"
  }
}

GitHub release generation

The tool automatically creates a github release with a changelog generated from your commits. All directories in the "bin" folder of your repository are automatically added as a zipped asset. If the directory name contains $version, it is replaced with the current version.

Usage

Add the package:

yarn add -D @faustt/release

Run this in your CI pipeline:

yarn release

To get the current version, run the following:

yarn release --current-version

To get the next version, run the following:

yarn release --next-version
# or (alias)
yarn release --new-version

To get only the changelog as markdown, run the following:

yarn release --changes-markdown