---
url: https://relizy.dev/typedoc/interfaces/GitCommit.md
---
[relizy](../index.md) / GitCommit

# Interface: GitCommit

Defined in: [packages/core/src/types.ts:134](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L134)

A conventional commit, as parsed by `parseCommits`

## Extends

* [`RawGitCommit`](RawGitCommit.md)

## Properties

### author

> **author**: [`GitCommitAuthor`](GitCommitAuthor.md)

Defined in: [packages/core/src/types.ts:130](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L130)

The author of the commit

#### Inherited from

[`RawGitCommit`](RawGitCommit.md).[`author`](RawGitCommit.md#author)

***

### authors

> **authors**: [`GitCommitAuthor`](GitCommitAuthor.md)\[]

Defined in: [packages/core/src/types.ts:144](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L144)

The author, then the `Co-authored-by` ones

***

### body

> **body**: `string`

Defined in: [packages/core/src/types.ts:124](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L124)

The body, followed by the `--name-status` list of the files of the commit

#### Inherited from

[`RawGitCommit`](RawGitCommit.md).[`body`](RawGitCommit.md#body)

***

### description

> **description**: `string`

Defined in: [packages/core/src/types.ts:136](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L136)

The subject without its type, scope and references

***

### hash?

> `optional` **hash?**: `string`

Defined in: [packages/core/src/types.ts:128](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L128)

The full commit hash, read by `getGitDiff`: none for a commit built by hand (the simulated squash commit)

#### Inherited from

[`RawGitCommit`](RawGitCommit.md).[`hash`](RawGitCommit.md#hash)

***

### isBreaking

> **isBreaking**: `boolean`

Defined in: [packages/core/src/types.ts:146](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L146)

`!` in the header, or `breaking change:` in the body

***

### message

> **message**: `string`

Defined in: [packages/core/src/types.ts:122](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L122)

The subject (first line)

#### Inherited from

[`RawGitCommit`](RawGitCommit.md).[`message`](RawGitCommit.md#message)

***

### references

> **references**: [`Reference`](Reference.md)\[]

Defined in: [packages/core/src/types.ts:142](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L142)

The hash, the pull requests and the issues the commit refers to

***

### scope

> **scope**: `string`

Defined in: [packages/core/src/types.ts:140](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L140)

The scope after `scopeMap`, empty when there is none

***

### shortHash

> **shortHash**: `string`

Defined in: [packages/core/src/types.ts:126](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L126)

The abbreviated commit hash

#### Inherited from

[`RawGitCommit`](RawGitCommit.md).[`shortHash`](RawGitCommit.md#shorthash)

***

### type

> **type**: `string`

Defined in: [packages/core/src/types.ts:138](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/core/src/types.ts#L138)

`feat`, `fix`...
