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

# Interface: MergePreviewConfig

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

## Properties

### check?

> `optional` **check?**: `boolean` | `"auto"`

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

Set the commit status `relizy/merge-preview` on the last commit of the
pull request: failed when the release of the merge would fail, success
with the released versions (`--check` and `--no-check` override it). Off
by default: the job of the merge preview already fails when the release
would fail, require the job in the protection of the branch. `auto` sets
it on GitHub only: on GitLab, a commit status would fail the pipeline a
second time

#### Default

```ts
false
```

***

### comment?

> `optional` **comment?**: `boolean`

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

Post the merge preview as a comment of the pull request, updated at each
run (`relizy merge-preview --no-comment` disables it)

#### Default

```ts
true
```

***

### commitlint?

> `optional` **commitlint?**: `boolean` | `"auto"`

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

Lint the commits of the pull request (and the commit of its squash merge)
with `relizy commitlint`: `auto` when the project uses it, a `commitlint`
option in its config or a commit-msg hook running `relizy commitlint`.
The commits failing it are warnings, they never fail the check: the
release does not lint the commits, and it is too late to reword them.
Off by default: run `relizy commitlint` in its own job to fail on them
(`--commitlint` and `--no-commitlint` override it)

#### Default

```ts
false
```

***

### squash?

> `optional` **squash?**: `boolean` | `"auto"`

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

Whether the merge squashes the commits of the pull request into one, its
title: `auto` reads it from GitHub (auto-merge, merge methods of the
repository) or GitLab (squash option of the merge request), and computes
both when only the merge will tell

#### Default

```ts
'auto'
```
