API 参考 / @142vip/changelog / Commit

接口: Commit

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

生成 Markdown 时使用的提交记录（可附带 GitHub 解析后的作者）

theme_extends

• GitCommitRecord

属性

author

author: GitCommitAuthor

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

主作者信息

继承自

GitCommitRecord.author

---

authors

authors: GitCommitAuthor[]

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

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

继承自

GitCommitRecord.authors

---

body

body: string

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

提交正文（首行之后的 body）

继承自

GitCommitRecord.body

---

description

description: string

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

去除引用后的描述文本

继承自

GitCommitRecord.description

---

isBreaking

isBreaking: boolean

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

是否含 breaking change（! 或 body 中的 BREAKING CHANGE）

继承自

GitCommitRecord.isBreaking

---

message

message: string

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

提交标题（Conventional Commits 首行）

继承自

GitCommitRecord.message

---

references

references: GitCommitReference[]

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

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

继承自

GitCommitRecord.references

---

resolvedAuthors?

optional resolvedAuthors?: GitAuthorInfo[]

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

经 GitHub API 解析后的作者（含 login）

---

scope

scope: string

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

scope（括号内，可能经 scopeMap 映射）

继承自

GitCommitRecord.scope

---

shortHash

shortHash: string

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

短 hash（%h）

继承自

GitCommitRecord.shortHash

---

type

type: string

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

commit type（如 feat / fix）

继承自

GitCommitRecord.type