relizy / GitCommit
Interface: GitCommit
Defined in: packages/core/src/types.ts:132
A conventional commit, as parsed by parseCommits
Extends
Properties
author
author:
GitCommitAuthor
Defined in: packages/core/src/types.ts:128
The author of the commit
Inherited from
authors
authors:
GitCommitAuthor[]
Defined in: packages/core/src/types.ts:142
The author, then the Co-authored-by ones
body
body:
string
Defined in: packages/core/src/types.ts:124
The body, followed by the --name-status list of the files of the commit
Inherited from
description
description:
string
Defined in: packages/core/src/types.ts:134
The subject without its type, scope and references
isBreaking
isBreaking:
boolean
Defined in: packages/core/src/types.ts:144
! in the header, or breaking change: in the body
message
message:
string
Defined in: packages/core/src/types.ts:122
The subject (first line)
Inherited from
references
references:
Reference[]
Defined in: packages/core/src/types.ts:140
The hash, the pull requests and the issues the commit refers to
scope
scope:
string
Defined in: packages/core/src/types.ts:138
The scope after scopeMap, empty when there is none
shortHash
shortHash:
string
Defined in: packages/core/src/types.ts:126
The abbreviated commit hash
Inherited from
type
type:
string
Defined in: packages/core/src/types.ts:136
feat, fix...