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

# Interface: MergePreviewOptions

Defined in: [packages/relizy/src/commands/merge-preview.ts:16](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/merge-preview.ts#L16)

The options of `relizy merge-preview`: the options of the release job it
previews (they decide the versions, the tags and the dist-tag), and the
outputs of the preview

## Extends

* `Pick`<[`ReleaseOptions`](ReleaseOptions.md), `"type"` | `"preid"` | `"suffix"` | `"from"` | `"to"` | `"force"` | `"publish"` | `"commit"` | `"gitTag"` | `"providerRelease"` | `"registry"` | `"tag"` | `"token"` | `"publishToken"` | `"privatePackages"` | `"prNumber"` | `"logLevel"` | `"configName"` | `"profile"` | `"config"` | `"overrides"` | `"onProgress"` | `"groups"` | `"report"` | `"prCommentMode"`>

## Properties

### changelog?

> `optional` **changelog?**: `boolean`

Defined in: [packages/relizy/src/commands/merge-preview.ts:38](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/merge-preview.ts#L38)

Generate the changelog entries of the release (`mergePreview.changelogs` of the report), without the hooks

#### Default

```ts
false
```

***

### check?

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

Defined in: [packages/relizy/src/commands/merge-preview.ts:28](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/merge-preview.ts#L28)

Override of `mergePreview.check` for this run (off by default, `auto`: on GitHub only). With `comment: false` too, the preview is
only computed: nothing is posted on the pull request. The report is still written where
`release.report` says (in GitHub Actions: the outputs and the summary of the job, unless
`release.report.github: false`)

***

### comment?

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

Defined in: [packages/relizy/src/commands/merge-preview.ts:21](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/merge-preview.ts#L21)

Override of `mergePreview.comment` for this run

***

### commit?

> `optional` **commit?**: `boolean`

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

Commit changes and create tag

#### Default

```ts
true
```

#### Inherited from

[`ReleaseConfig`](ReleaseConfig.md).[`commit`](ReleaseConfig.md#commit)

***

### commitlint?

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

Defined in: [packages/relizy/src/commands/merge-preview.ts:33](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/commands/merge-preview.ts#L33)

Override of `mergePreview.commitlint` for this run (off by default): `true` lints
the commits of the pull request, as warnings

***

### config?

> `optional` **config?**: [`ResolvedRelizyConfig`](../type-aliases/ResolvedRelizyConfig.md)

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

Config already resolved by `loadRelizyConfig()`: used as is instead of loading the config file
(the profile, the `overrides` and the options of the call still apply over it)

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`config`](ReleaseOptions.md#config)

***

### configName?

> `optional` **configName?**: `string`

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

#### Default

```ts
'relizy'
```

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`configName`](ReleaseOptions.md#configname)

***

### force?

> `optional` **force?**: `boolean`

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

Bump even if there are no commits

#### Default

```ts
false
```

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`force`](ReleaseOptions.md#force)

***

### from?

> `optional` **from?**: `string`

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

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`from`](ReleaseOptions.md#from)

***

### gitTag?

> `optional` **gitTag?**: `boolean`

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

Create tag

#### Default

```ts
true
```

#### Inherited from

[`ReleaseConfig`](ReleaseConfig.md).[`gitTag`](ReleaseConfig.md#gittag)

***

### groups?

> `optional` **groups?**: `string`\[]

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

Only process these version groups (`monorepo.groups`), by name.

#### Default

```ts
all groups
```

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`groups`](ReleaseOptions.md#groups)

***

### logLevel?

> `optional` **logLevel?**: [`RelizyLogLevel`](../type-aliases/RelizyLogLevel.md)

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

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`logLevel`](ReleaseOptions.md#loglevel)

***

### onProgress?

> `optional` **onProgress?**: [`RelizyEventListener`](../type-aliases/RelizyEventListener.md)

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

Called with each event of the run (steps started, done, failed or skipped, progress, links,
logs, the end): the same events as `RELIZY_REPORTER=json`, for a program following the run.
A listener that throws does not stop the run.

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`onProgress`](ReleaseOptions.md#onprogress)

***

### overrides?

> `optional` **overrides?**: [`RelizyConfigOverrides`](../type-aliases/RelizyConfigOverrides.md)

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

Options applied over the config file (or over `config`), under the options of the call:
a local overlay without writing a file. The hooks of the overlay run after those of the config.

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`overrides`](ReleaseOptions.md#overrides)

***

### prCommentMode?

> `optional` **prCommentMode?**: [`PrCommentMode`](../type-aliases/PrCommentMode.md)

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

Override of `prComment.mode` for this run

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`prCommentMode`](ReleaseOptions.md#prcommentmode)

***

### preid?

> `optional` **preid?**: `string`

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

Prerelease identifier (e.g. 'beta', 'alpha')

#### Inherited from

[`BumpConfig`](BumpConfig.md).[`preid`](BumpConfig.md#preid)

***

### privatePackages?

> `optional` **privatePackages?**: [`PrivatePackages`](../type-aliases/PrivatePackages.md)

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

Override of `monorepo.privatePackages`: `release` releases the private packages too

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`privatePackages`](ReleaseOptions.md#privatepackages)

***

### prNumber?

> `optional` **prNumber?**: `number`

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

Override PR/MR number for PR comment features

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`prNumber`](ReleaseOptions.md#prnumber)

***

### profile?

> `optional` **profile?**: `string`

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

Release profile to apply (`profiles` of the config), as `--profile`: its options
come after the config file and before the options of this run

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`profile`](ReleaseOptions.md#profile)

***

### providerRelease?

> `optional` **providerRelease?**: `boolean`

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

Publish release to your repository (github or gitlab)

#### Default

```ts
true
```

#### Inherited from

[`ReleaseConfig`](ReleaseConfig.md).[`providerRelease`](ReleaseConfig.md#providerrelease)

***

### publish?

> `optional` **publish?**: `boolean`

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

Publish release to your registry

#### Default

```ts
true
```

#### Inherited from

[`ReleaseConfig`](ReleaseConfig.md).[`publish`](ReleaseConfig.md#publish)

***

### publishToken?

> `optional` **publishToken?**: `string`

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

NPM token (e.g. "123456")

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`publishToken`](ReleaseOptions.md#publishtoken)

***

### registry?

> `optional` **registry?**: `string`

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

NPM registry URL (e.g. `https://registry.npmjs.org/`). Without it, the
registry of the npm config (`.npmrc`), unless `registries` is set: the
packages then go only to the declared registries

#### Inherited from

[`PublishConfig`](PublishConfig.md).[`registry`](PublishConfig.md#registry)

***

### report?

> `optional` **report?**: [`ReleaseReportConfig`](ReleaseReportConfig.md)

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

Report of the release, to run something only when a release happens:
the outputs and the summary of GitHub Actions, a JSON file, a dotenv file
(GitLab CI). Written in dry-run too, where `released` is `false`.

#### Default

```ts
{ github: true }
```

#### Inherited from

[`ReleaseConfig`](ReleaseConfig.md).[`report`](ReleaseConfig.md#report)

***

### suffix?

> `optional` **suffix?**: `string`

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

Custom suffix for prerelease versions - replace the last .X with .suffix (e.g. 1.0.0-beta.0 -> 1.0.0-beta.suffix)

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`suffix`](ReleaseOptions.md#suffix)

***

### tag?

> `optional` **tag?**: `string`

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

NPM tag (e.g. `latest`)

#### Inherited from

[`PublishConfig`](PublishConfig.md).[`tag`](PublishConfig.md#tag)

***

### to?

> `optional` **to?**: `string`

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

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`to`](ReleaseOptions.md#to)

***

### token?

> `optional` **token?**: `string`

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

#### Inherited from

[`ReleaseOptions`](ReleaseOptions.md).[`token`](ReleaseOptions.md#token)

***

### type?

> `optional` **type?**: [`BumpReleaseType`](../type-aliases/BumpReleaseType.md)

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

Release type (e.g. 'major', 'minor', 'patch', 'prerelease', 'prepatch', 'preminor', 'premajor')

#### Default

```ts
'release'
```

#### Inherited from

[`BumpConfig`](BumpConfig.md).[`type`](BumpConfig.md#type)
