类 ChangelogApi

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

索引

构造函数

方法

changelogCoreHandler generateChangelogInfo upsertChangelogDoc writeChangelogFile

构造函数

constructor

new ChangelogApi(): ChangelogApi

返回 ChangelogApi

方法

changelogCoreHandler

changelogCoreHandler(cliOptions: ChangelogCliOptions): Promise<void>
CLI 主流程：生成内容 →（可选）写文件 →（可选）发布 GitHub Release
参数
- cliOptions: ChangelogCliOptions
返回 Promise<void>
- 定义于 changelog/src/core/apis/changelog.api.ts:74

generateChangelogInfo

generateChangelogInfo(
config: ChangelogGenerateOptions,
): Promise<GenerateChangelogResult>
生成 CHANGELOG 正文与 Release 元数据（不写文件、不创建 GitHub Release）
参数
- config: ChangelogGenerateOptions
返回 Promise<GenerateChangelogResult>
- 定义于 changelog/src/core/apis/changelog.api.ts:17

upsertChangelogDoc

upsertChangelogDoc(
    outputPath: string,
    markdown: string,
    releaseVersionName: string,
    markdownHeader: string,
): Promise<void>
在已有 CHANGELOG.md 顶部插入新版本节
参数
- outputPath: string
- markdown: string
- releaseVersionName: string
- markdownHeader: string
返回 Promise<void>
- 定义于 changelog/src/core/apis/changelog.api.ts:43

writeChangelogFile

writeChangelogFile(
cliOptions: ChangelogCliOptions,
): Promise<GenerateChangelogResult>
仅写入 CHANGELOG.md，不触发 GitHub Release（fa release / release-version 集成）
参数
- cliOptions: ChangelogCliOptions
返回 Promise<GenerateChangelogResult>
- 定义于 changelog/src/core/apis/changelog.api.ts:140