API 参考 / @142vip/changelog / ChangelogApi

类: ChangelogApi

定义于: changelog/src/core/apis/changelog.api.ts:15

CHANGELOG 生成、写盘与 GitHub Release 流程。 对外由 changelogApi 单例导出；fa changelog 与独立 bin 共用。

构造函数

构造函数

new ChangelogApi(): ChangelogApi

返回

ChangelogApi

方法

changelogCoreHandler()

changelogCoreHandler(cliOptions): Promise<void>

定义于: changelog/src/core/apis/changelog.api.ts:74

CLI 主流程：生成内容 →（可选）写文件 →（可选）发布 GitHub Release

参数

cliOptions

ChangelogCliOptions

返回

Promise<void>

---

generateChangelogInfo()

generateChangelogInfo(config): Promise<GenerateChangelogResult>

定义于: changelog/src/core/apis/changelog.api.ts:17

生成 CHANGELOG 正文与 Release 元数据（不写文件、不创建 GitHub Release）

参数

config

ChangelogGenerateOptions

返回

Promise<GenerateChangelogResult>

---

upsertChangelogDoc()

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

定义于: changelog/src/core/apis/changelog.api.ts:43

在已有 CHANGELOG.md 顶部插入新版本节

参数

outputPath

string

markdown

string

releaseVersionName

string

markdownHeader

string

返回

Promise<void>

---

writeChangelogFile()

writeChangelogFile(cliOptions): Promise<GenerateChangelogResult>

定义于: changelog/src/core/apis/changelog.api.ts:140

仅写入 CHANGELOG.md，不触发 GitHub Release（fa release / release-version 集成）

参数

cliOptions

ChangelogCliOptions

返回

Promise<GenerateChangelogResult>