Skip to content

API 参考 / @142vip/changelog / GitCommitRecord

接口: GitCommitRecord ​

定义于: changelog/src/core/changelog.interface.ts:56

经 Conventional Commits 规则解析后的提交记录

theme_extends ​

theme_extended_by ​

属性 ​

author ​

author: GitCommitAuthor

定义于: changelog/src/core/changelog.interface.ts:22

主作者信息

继承自 ​

GitCommitRaw.author


authors ​

authors: GitCommitAuthor[]

定义于: changelog/src/core/changelog.interface.ts:66

主作者 + Co-authored-by 合并后的作者列表


body ​

body: string

定义于: changelog/src/core/changelog.interface.ts:18

提交正文(首行之后的 body)

继承自 ​

GitCommitRaw.body


description ​

description: string

定义于: changelog/src/core/changelog.interface.ts:58

去除引用后的描述文本


isBreaking ​

isBreaking: boolean

定义于: changelog/src/core/changelog.interface.ts:68

是否含 breaking change(! 或 body 中的 BREAKING CHANGE)


message ​

message: string

定义于: changelog/src/core/changelog.interface.ts:16

提交标题(Conventional Commits 首行)

继承自 ​

GitCommitRaw.message


references ​

references: GitCommitReference[]

定义于: changelog/src/core/changelog.interface.ts:64

从描述与 hash 提取的引用列表


scope ​

scope: string

定义于: changelog/src/core/changelog.interface.ts:62

scope(括号内,可能经 scopeMap 映射)


shortHash ​

shortHash: string

定义于: changelog/src/core/changelog.interface.ts:20

短 hash(%h)

继承自 ​

GitCommitRaw.shortHash


type ​

type: string

定义于: changelog/src/core/changelog.interface.ts:60

commit type(如 feat / fix)