@142vip工程化

切换主题

API 参考 / @142vip/changelog / ChangelogAPI

变量: ChangelogAPI ​

const ChangelogAPI: object

定义于: changelog/src/core/changelog.api.ts:163

changelog相关API

类型声明 ​

changelogCoreHandler() ​

changelogCoreHandler: (cliOptions) => Promise<void>

处理changelog业务

参数 ​

cliOptions ​

ChangelogCliOptions

返回 ​

Promise<void>

generateChangelogInfo() ​

generateChangelogInfo: (config) => Promise<GenerateChangelogResult>

处理git changelog记录生成

参数 ​

config ​

ChangelogGenerateOptions

返回 ​

Promise<GenerateChangelogResult>

upsertChangelogDoc() ​

upsertChangelogDoc: (outputPath, markdown, releaseVersionName, markdownHeader) => Promise<void>

创建或更新changelog文档

参数 ​

outputPath ​

string

markdown ​

string

releaseVersionName ​

string

markdownHeader ​

string

返回 ​

Promise<void>