Releaser

Release scripts for all of Escale's workflows

• Releaser
  • What it does
  • Requirements
  • Usage
    • Options
    • Node.js shortcut
    • Makefile shortcut
  • What it doesn't do

What it does

1. Prints the commits that are being considered for the version bump
2. Uses conventional-recommended-bump and semver to figure out the next version
3. Asks for your approval
4. Creates the new tag on the current commit
5. Pushes the tag

Requirements

• npx - automatically bundled with Node.js 8.2+
• Git

Usage

npx github:escaletech/releaser [--update-package-json] [--major-version <version>] [--gpg-sign]

Options

• --update-package-json: pass this option if you want the releaser to update the version number in your package.json file. ⚠️ Only use this option for releasing NPM packages, not applications.
• --major-version: pass this option followed by a major version number to generate a tag specifically for a major version.
• --gpg-sign: pass this option to GPG sign your generated tags.
• --release-title: pass this option followed by a title to create an annotated tag using that title as the message.

Node.js shortcut

For calling with npm run release in Node.js projects:

{
  "scripts": {
    "release": "npx github:escaletech/releaser"
  }
}

Makefile shortcut

For calling with make release, in Go or Terraform projects:

release:
	npx github:escaletech/releaser

What it doesn't do

• It doesn't update any changelog file. To do so, we recommend using conventional-changelog or similar tool.