API 参考 / @142vip/changelog / GitCommitAPI

const GitCommitAPI: object

Defined in: changelog/src/core/git-commit.api.ts:225

getGitCommitDiff: (options) => Promise<GitCommitRaw[]>

获取不同tag之间的commit记录

GitCommitDiffOptions

Promise<GitCommitRaw[]>

parseCommitsToMarkdownStr: (commits, options) => Promise<string>

生成Markdown文档记录的每行记录

Commit[]

string

boolean

boolean

string

boolean | "multiple"

string

string

Record<string, string>

string

{ breakingChanges?: string; }

string

string

Record<string, { title: string; }>

Promise<string>

parseGitCommits: (commits, scopeMap) => GitCommitRecord[]

解析所有Commit信息

GitCommitRaw[]

Record<string, string>

GitCommitRecord[]