API 参考
    正在准备搜索索引...

    接口 ChangelogGenerateOptions

    合并配置后的完整生成选项

    interface ChangelogGenerateOptions {
        baseUrl: string;
        baseUrlApi: string;
        capitalize: boolean;
        contributors: boolean;
        dryRun?: boolean;
        emoji: boolean;
        from: string;
        group: boolean | "multiple";
        header?: string;
        name: string;
        output?: string;
        prerelease: boolean;
        repo: string;
        scopeMap: Record<string, string>;
        scopeName?: string;
        titles: { breakingChanges?: string };
        to: string;
        types: Record<string, { semver?: VipSemverReleaseType; title: string }>;
    }
    索引
    baseUrl: string

    GitHub Web 主机(默认 github.com)

    baseUrlApi: string

    GitHub API 主机(默认 api.github.com)

    capitalize: boolean

    描述首字母大写

    contributors: boolean

    是否解析 GitHub 贡献者

    dryRun?: boolean

    试运行:不写文件、不创建 Release

    emoji: boolean

    章节标题是否保留 emoji

    from: string

    提交范围起点

    group: boolean | "multiple"

    是否按 scope 分组;multiple 表示仅多 commit 的 scope 分组

    header?: string

    新建 CHANGELOG.md 时的文件头

    name: string

    Release 名称

    output?: string

    CHANGELOG.md 输出路径

    prerelease: boolean

    GitHub Pre-release 标记

    repo: string

    远程仓库 owner/repo

    scopeMap: Record<string, string>

    scope 显示名映射(如 utils → @142vip/utils)

    scopeName?: string

    Monorepo 子包 scope 名

    titles: { breakingChanges?: string }

    额外章节标题

    类型声明

    • 可选breakingChanges?: string

      Breaking Changes 章节标题

    to: string

    提交范围终点 / Release tag

    types: Record<string, { semver?: VipSemverReleaseType; title: string }>

    Conventional Commits type → 章节标题与 semver 提示