引入

import {
  genVersionAndSendChangeLog,
  genVersionTip,
  genVersion
} from 't-comm';

// 不支持 tree-shaking 的项目
import {
  genVersionAndSendChangeLog,
  genVersionTip,
  genVersion
} from 't-comm/lib/version-tip/index';

// 只支持 ESM 的项目
import {
  genVersionAndSendChangeLog,
  genVersionTip,
  genVersion
} from 't-comm/es/version-tip/index';

genVersionAndSendChangeLog(options)

描述：

运行standard-version，并且发送changelog到机器人

参数：

参数名	类型	描述
options	object	配置
config.appInfo	object	package.json信息
config.root	string	项目根路径
config.changeLogFilePath	string	changelog文件地址
config.webhookUrl	string	机器人hook地址
config.chatId	string	会话id

genVersionTip(config)

描述：

生成版本信息，可以用来发送到群聊中

参数：

参数名	类型	描述
config	object	配置信息
config.readmeFilePath	string	changelog文件地址
config.appInfo	object	package.json信息

返回: string

版本信息

示例

const appInfo = require(`${rootPath}/package.json`);
const readmeFilePath = `${rootPath}/CHANGELOG.md`;

const content = genVersionTip({
  readmeFilePath,
  appInfo,
});

genVersion(config)

描述：

自动生成version，核心是利用 standard-version 命令

参数：

参数名	类型	描述
config	object	配置信息
config.root	string	项目根路径

返回: boolean

是否执行了 standard-version

示例

genVersion({
  root: process.cwd()
})