relizy / CommitlintCommit
Interface: CommitlintCommit
Defined in: src/types.ts:1410
A commit message parsed by relizy commitlint, with the commitlint field names, enriched with what relizy knows about the commit.
Properties
body
body:
string
Defined in: src/types.ts:1416
Text between the header and the footer
bump?
optionalbump?:SemverBumpType
Defined in: src/types.ts:1428
Version bump the commit triggers, computed by relizy from types
files?
optionalfiles?:string[]
Defined in: src/types.ts:1432
Changed files (staged files, or the files of the commit in a range), when known
footer
footer:
string
Defined in: src/types.ts:1418
Trailing block of Token: value lines (BREAKING CHANGE:, Closes #12...)
hash?
optionalhash?:string
Defined in: src/types.ts:1436
Hash of the commit, when linting a range
header
header:
string
Defined in: src/types.ts:1414
First line of the message
isBreaking
isBreaking:
boolean
Defined in: src/types.ts:1426
Breaking change as detected by relizy (! or breaking change: in the body)
packages?
optionalpackages?:string[]
Defined in: src/types.ts:1434
Names of the workspace packages touched by files
raw
raw:
string
Defined in: src/types.ts:1412
Full message, comments removed
references
references:
Reference[]
Defined in: src/types.ts:1430
Pull request, issue and hash references found by relizy
scope
scope:
string
Defined in: src/types.ts:1422
Scope, as written in the header
subject
subject:
string
Defined in: src/types.ts:1424
Description of the header, as written
type
type:
string
Defined in: src/types.ts:1420
Type, empty when the header is not a conventional commit