README.zh-CN.md

Varlet Release

中文 | English

介绍

Varlet Release 是一个用于发布所有包、生成变更日志和检测 commit message 的工具。

安装

npm

npm i @varlet/release -D

yarn

yarn add @varlet/release -D

pnpm

pnpm add @varlet/release -D

使用

使用命令

# 发布所有包并生成变更日志
npx vr release

# 指定远程仓库名称
npx vr release -r <remote>
# or
npx vr release --remote <remote>

# 仅生成变更日志
npx vr changelog

# 指定变更日志文件名
npx vr changelog -f <filename>
# or
npx vr changelog --file <filename>

# 检测 commit message
npx vr lint-commit <gitMessagePath>

配置

release

参数	说明
-r --remote <remote>	指定远程仓库名称

changelog

参数	说明
-f --file <filename>	指定变更日志文件名
-rc --releaseCount <releaseCount>	发布数量

lint-commit

参数	说明
<gitMessagePath>	提交 git message 的临时文件路径。git 钩子 commit-msg 会传递这个参数。

自定义处理

示例

import { release, changelog } from '@varlet/release'

// Do what you want to do...
release()

你可以传入一个 task，在包版本更改后，在发布之前会调用 task。

import { release, changelog } from '@varlet/release'

async function task() {
  await doSomething1()
  await doSomething2()
}

release({ task })

类型

interface ReleaseCommandOptions {
  remote?: string
  task?(): Promise<void>
}
function release(options: ReleaseCommandOptions): Promise<void>

interface ChangelogCommandOptions {
  file?: string
  releaseCount?: number
}
function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
function commitLint(gitMessagePath: string): void

License

MIT