X-Release

A tool that helps you to create a new release quickly.

Install

1pnpm i @0x-jerry/x-release -D
2# or
3pnpm i @0x-jerry/x-release -g

Usage

Usage:
  $ x-release [new-version]

Commands:
  [new-version]  the tasks to run.

Example:

- x-release --patch
- x-release 0.0.1
- x-release 0.1.1 --publish false


For more info, run any command with the `--help` flag:
  $ x-release --help

Options:
  --patch                auto-increment patch version number
  --minor                auto-increment minor version number
  --major                auto-increment major version number
  --prepatch             auto-increment prepatch version number
  --preminor             auto-increment preminor version number
  --premajor             auto-increment premajor version number
  --prerelease           auto-increment prerelease version number
  --publish              run npm publish, default is true
  --tag <tag-tpl>        new tag format, default is: "v${version}"
  --commit <commit-tpl>  the commit message template, default is: "chore: release v${version}"
  -h, --help             Display this message
  -v, --version          Display version number

Configuration

Config file: release.conf.ts

Example config file:

1import { defineConfig } from '@0x-jerry/x-release'
2
3export default defineConfig({
4  /**
5   * run npm publish, default true
6   */
7  publish: true,
8  /**
9   * tag template
10   */
11  tag: '${prefix}v${version}',
12  /**
13   * commit template
14   */
15  commit: 'chore: release ${prefix}v${version}',
16  /**
17   * run tasks after bump version
18   */
19  tasks: [
20    'npm test', // run npm test
21    async (ctx) => {
22      console.log('new version is:', ctx.nextVersion)
23
24      await ctx.run(`echo "custom script, all tasks are finished!"`)
25    },
26  ],
27})

Package.json release

1{
2  "release": {
3    "publish": true,
4    "tag": "${prefix}v${version}",
5    "commit": "chore: release ${prefix}v${version}",
6    "tasks": [
7      "npm run test",
8      "echo 'run custom script after bump version'",
9      "echo 'this should be the last script'"
10    ]
11  }
12}