@takuma-ru/rlse

All-in-one release flow execution package.

Getting Started

1. Install

npm install @takuma-ru/rlse

2. Add script to package.json

{
  "scripts": {
    "rlse": "rlse -n <name> -l <patch | minor | major | pre> -c <build command>"
  }
}

3. Run

npm run rlse

Configure settings via CLI

Option	Description	Type	Default
-n, --name	Package name	string
-l, --level	Release level	string
-c, --command	Build command	string
--pre	Pre-release	boolean	false
--git-user-name	git config --local user.name <name>	string
--git-user-email	git config --local user.email <email>	string
-k	Skip release step	string[]	[]

Configure settings via Setting file

You can configure it without specifying options in the cli by creating rlse.config.ts in the project root. In addition to ts, the following file formats are supported.

• rlse.config.ts
• rlse.config.js
  • rlse.config.mjs
  • rlse.config.cjs
• rlse.config.json

Example

import { defineConfig } from "@takuma-ru/rlse";

export default defineConfig({
  name: "vanilla-ts",
  level: "patch",
  pre: false,
  buildCmd: "pnpm build",
  gitUserName: "github-actions[bot]",
  gitUserEmail: "41898282+github-actions[bot]@users.noreply.github.com",
  dryRun: true,
  skipStep: ["config", "commit-changes", "create-release-branch"],
});

defineConfig Types

type RlseConfig = {
  name?: string | undefined;
  pre?: boolean | undefined;
  level?: "patch" | "minor" | "major" | "preup" | undefined;
  buildCmd?: string | undefined;
  dryRun?: boolean | undefined;
  gitUserName?: string | undefined;
  gitUserEmail?: string | undefined;
  skipStep?:
    | (
        | "config"
        | "create-release-branch"
        | "build"
        | "commit-changes"
        | "publish"
      )[]
    | undefined;
};

License

Mozilla Public License Version 2.0