Skip to content

引入

ts
import { insertDocChangeLog } from 't-comm';

// 不支持 tree-shaking 的项目
import { insertDocChangeLog} from 't-comm/lib/change-log/index';

// 只支持 ESM 的项目
import { insertDocChangeLog} from 't-comm/es/change-log/index';

insertDocChangeLog(params)

描述

同步最新版本的更新日志

参数

参数名类型描述
paramsobject

参数

params.changelogPathstring

源 change-log路径

params.docChangelogPathstring

文档 change-log 路径

params.packageJsonPathstring

package.json 路径

示例

ts
const DOC_CHANGE_LOG_PATH = './docs/CHANGELOG.md';
const SOURCE_CHANGE_LOG_PATH = './CHANGELOG.md';

insertDocChangeLog({
  changelogPath: SOURCE_CHANGE_LOG_PATH,
  docChangeLog: DOC_CHANGE_LOG_PATH,
  packageJsonPath: './package.json',
});