feat(@skyroc/cli): ✨ add release scripts and changelog generation options to streamline versioning process

Author: Ohh-889

internal/cli/src/commands/release.ts

@@ -1,12 +1,38 @@
+import type { VersionBumpOptions } from 'bumpp';
 import { versionBump } from 'bumpp';
 
-export async function release(execute = 'npx soy changelog', push = true) {
-  await versionBump({
+import type { CliOption, ReleaseOptions } from '../types';
+
+export interface ArgsReleaseOptions extends ReleaseOptions {
+  releaseOptions?: CliOption['releaseOptions'];
+}
+
+export async function releaseArgs(agrs: ArgsReleaseOptions) {
+  const { execute = 'npx sr changelog', packageName, preid = 'beta', push = true, release, releaseOptions } = agrs;
+
+  const defaultOptions = {
     all: true,
     commit: 'chore(projects): release v%s',
     execute,
     files: ['**/package.json', '!**/node_modules'],
+    preid,
     push,
+    release,
     tag: true
-  });
+  };
+
+  const cliOptions =
+    typeof releaseOptions === 'function'
+      ? releaseOptions({
+          execute,
+          packageName,
+          preid,
+          push,
+          release
+        })
+      : releaseOptions;
+
+  const options = releaseOptions ? cliOptions : defaultOptions;
+
+  await versionBump(options as VersionBumpOptions);
 }

internal/cli/src/config/index.ts

@@ -25,7 +25,8 @@ const defaultOptions: CliOption = {
     /^Automatic merge(.*)/,
     /^Auto-merged (.*?) into (.*)/
   ],
-  ncuCommandArgs: ['--deep', '-u']
+  ncuCommandArgs: ['--deep', '-u'],
+  releaseOptions: {}
 };
 
 export async function loadCliOptions(overrides?: Partial<CliOption>, cwd = process.cwd()) {

internal/cli/src/index.ts

@@ -3,7 +3,7 @@ import { blue, lightGreen } from 'kolorist';
 
 import { version } from '../package.json';
 
-import { cleanup, genChangelog, gitCommit, gitCommitVerify, release, updatePkg } from './commands';
+import { cleanup, genChangelog, gitCommit, gitCommitVerify, releaseArgs, updatePkg } from './commands';
 import { loadCliOptions } from './config';
 import type { Lang } from './locales';
 import type { CliOption, GitCommitScope, GitCommitType, GitEmojiItem } from './types';
@@ -33,8 +33,14 @@ interface CommandArg {
    * @default 'en-us'
    */
   lang?: Lang;
+  /** The package name to bump */
+  packageName?: string;
+  /** The prerelease type (e.g. "alpha", "beta", "next"). Defaults to "beta" */
+  preid?: string;
   /** Indicates whether to push the git commit and tag. Defaults to true */
   push?: boolean;
+  /** The release type (e.g. "conventional", "npm", "yarn", "pnpm"). Defaults to "conventional" */
+  release?: string;
   /** Generate changelog by total tags */
   total?: boolean;
 }
@@ -52,12 +58,18 @@ export async function setupCli() {
     )
     .option('-p, --push', 'Indicates whether to push the git commit and tag')
     .option('-t, --total', 'Generate changelog by total tags')
+    .option('-pn, --packageName <packageName>', 'The package name to bump')
     .option(
       '-c, --cleanupDir <dir>',
       'The glob pattern of dirs to cleanup, If not set, it will use the default value, Multiple values use "," to separate them'
     )
     .option('-l, --lang <lang>', 'display lang of cli', { default: 'en-us', type: [String] })
     .option('-m, --gitEmoji <emoji>', 'git commit emoji')
+    .option('-pr, --preid <preid>', 'The prerelease type (e.g. "alpha", "beta", "next"). Defaults to "beta"')
+    .option(
+      '-re, --release <release>',
+      'The release type (e.g. "conventional", "npm", "yarn", "pnpm"). Defaults to "conventional"'
+    )
     .help();
 
   const commands: CommandWithAction<CommandArg> = {
@@ -87,7 +99,14 @@ export async function setupCli() {
     },
     release: {
       action: async args => {
-        await release(args?.execute, args?.push);
+        await releaseArgs({
+          execute: args?.execute,
+          packageName: args?.packageName,
+          preid: args?.preid,
+          push: args?.push,
+          release: args?.release,
+          releaseOptions: cliOptions.releaseOptions
+        });
       },
       desc: 'release: update version, generate changelog, commit code'
     },

internal/cli/src/types/index.ts

@@ -1,4 +1,5 @@
 import type { ChangelogOption } from '@soybeanjs/changelog';
+import type { VersionBumpOptions } from 'bumpp';
 
 /**
  * Git commit type item [type, description]
@@ -15,6 +16,14 @@ export type GitCommitScope = readonly [scope: string, description: string];
  */
 export type GitEmojiItem = readonly [type: string, emoji: string];
 
+export type ReleaseOptions = {
+  execute?: string;
+  packageName?: string;
+  preid?: string;
+  push?: boolean;
+  release?: string;
+};
+
 export interface CliOption {
   /**
    * Options of generate changelog
@@ -55,4 +64,10 @@ export interface CliOption {
    * @default ['--deep', '-u']
    */
   ncuCommandArgs: string[];
+  /**
+   * Options of bump package
+   *
+   * @link https://github.com/bevry/bumpp
+   */
+  releaseOptions: Partial<VersionBumpOptions> | ((options: ReleaseOptions) => VersionBumpOptions);
 }

package.json

@@ -9,6 +9,7 @@
   },
   "scripts": {
     "build": "turbo run build",
+    "changelog": "sr changelog",
     "check-types": "turbo run check-types",
     "commit": "sr git-commit",
     "cpn": "tsx script/cp.ts",
@@ -18,7 +19,11 @@
     "lint": "turbo run lint",
     "lint:fix": "eslint . --fix",
     "postinstall": "tsx script/postinstall.ts",
-    "release": "tsx script/bump.ts"
+    "release": "tsx script/bump.ts",
+    "release:alpha": "tsx script/release.ts --type alpha",
+    "release:beta": "tsx script/release.ts --type beta",
+    "release:prod": "tsx script/release.ts --type prod",
+    "release:rc": "tsx script/release.ts --type rc"
   },
   "dependencies": {
     "@changesets/changelog-github": "0.5.1",

script/bump.ts

@@ -0,0 +1,101 @@
+import { execSync } from 'node:child_process';
+
+/**
+ * Release type for different version publishing scenarios
+ * - prod: Production release (stable version)
+ * - beta/alpha/rc: Pre-release versions for testing
+ */
+type ReleaseType = 'alpha' | 'beta' | 'prod' | 'rc';
+
+/**
+ * Get default configuration for each release type
+ * @param type - The release type (prod, beta, alpha, rc)
+ * @returns Default configuration including preid and release strategy
+ */
+function getDefaultConfig(type: ReleaseType) {
+  const configs = {
+    alpha: { preid: 'alpha', release: 'prerelease' },
+    beta: { preid: 'beta', release: 'prerelease' },
+    prod: { preid: undefined, release: 'patch' },
+    rc: { preid: 'rc', release: 'prerelease' }
+  };
+
+  return configs[type];
+}
+
+/**
+ * Parse command line arguments
+ * @returns Parsed arguments as key-value pairs
+ */
+function parseArgs() {
+  const args = process.argv.slice(2);
+  const result: Record<string, string | undefined> = {
+    push: 'true'
+  };
+
+  for (let i = 0; i < args.length; i += 1) {
+    const arg = args[i];
+    if ((arg === '--type' || arg === '-t') && args[i + 1]) {
+      result.type = args[i + 1];
+      i += 1;
+    } else if ((arg === '--path' || arg === '--packageName' || arg === '-p') && args[i + 1]) {
+      result.packageName = args[i + 1];
+      i += 1;
+    } else if ((arg === '--release' || arg === '-r') && args[i + 1]) {
+      result.release = args[i + 1];
+      i += 1;
+    } else if ((arg === '--preid' || arg === '-pr') && args[i + 1]) {
+      result.preid = args[i + 1];
+      i += 1;
+    } else if (arg === '--push' && args[i + 1]) {
+      result.push = args[i + 1];
+      i += 1;
+    } else if (arg === '--no-push') {
+      result.push = 'false';
+    }
+  }
+
+  return result;
+}
+
+const options = parseArgs();
+
+// Validate type parameter - must be one of: prod, beta, alpha, rc
+if (!options.type || !['prod', 'beta', 'alpha', 'rc'].includes(options.type)) {
+  // eslint-disable-next-line no-console
+  console.error('❌ Release type is required: --type prod|beta|alpha|rc');
+  process.exit(1);
+}
+
+const type = options.type as ReleaseType;
+const defaultConfig = getDefaultConfig(type);
+
+// Build the command with appropriate arguments
+const cmdParts = ['sr', 'release'];
+
+if (options.packageName) {
+  cmdParts.push('--packageName', options.packageName);
+}
+
+// Use user-specified parameters if provided, otherwise use default values
+const release = options.release || defaultConfig.release;
+cmdParts.push('--release', release);
+
+// Only pre-release versions need preid (beta, alpha, rc)
+const preid = options.preid || defaultConfig.preid;
+if (preid) {
+  cmdParts.push('--preid', preid);
+}
+
+if (options.push === 'true') {
+  cmdParts.push('--push');
+}
+
+const cmd = cmdParts.join(' ');
+
+// eslint-disable-next-line no-console
+console.log(`🚀 Executing command: ${cmd}`);
+
+execSync(cmd, {
+  stdio: 'inherit'
+});

script/release.ts

@@ -1,6 +1,15 @@
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+
 import { defineConfig } from '@skyroc/cli';
 
+let tag = '';
+
 export default defineConfig({
+  changelogOptions: {
+    to: tag
+  },
   // Custom git commit scopes
   // If not set, will use default scopes from locale
   gitCommitScopes: [
@@ -19,5 +28,53 @@ export default defineConfig({
     ['@skyroc/cli', 'CLI for skyroc-ui'],
     ['skyroc-ui-docs', 'Docs for skyroc-ui'],
     ['other', 'other changes']
-  ]
+  ],
+  releaseOptions: options => {
+    const { packageName: pathName, preid, release } = options;
+
+    // Validate package name is provided
+    if (!pathName) {
+      // eslint-disable-next-line no-console
+      console.error('❌ Package name is required, e.g.: pnpm release skyroc-form');
+      process.exit(1);
+    }
+    const cwd = path.resolve(pathName);
+    const pkgPath = path.join(cwd, 'package.json');
+    if (!fs.existsSync(pkgPath)) {
+      // eslint-disable-next-line no-console
+      console.error(`❌ Package not found: ${pkgPath}`);
+      process.exit(1);
+    }
+
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+
+    const current = pkg.version;
+
+    const pkgName = pkg.name;
+
+    console.log(`🔍 Current version: ${pkgName}@${current}`);
+
+    return {
+      commit: `chore(${pkgName}): release v%s`,
+      confirm: false,
+      cwd,
+      execute: op => {
+        console.log('New version:', op.state.newVersion);
+
+        tag = `${pkgName}@${op.state.newVersion}`;
+        execSync(`npx sr changelog`);
+      },
+      files: ['package.json'],
+      preid,
+      progress(info) {
+        // Log release progress events
+
+        console.log(`[${info.event}] ${info.newVersion ?? ''} ${info.commit ?? ''}`);
+      },
+      // Automatic commit type analysis
+      push: false,
+      release,
+      tag: `${pkgName}@%s`
+    };
+  }
 });