---
url: https://relizy.dev/typedoc/functions/mergePreview.md
---
[relizy](../index.md) / mergePreview

# Function: mergePreview()

> **mergePreview**(`options?`): `Promise`<[`ReleaseReport`](../interfaces/ReleaseReport.md)>

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

`relizy merge-preview`: what the merge of the pull request of the CI job
releases, computed as the release of the merge will run (with the options of
the release job), without writing, committing, tagging, pushing nor
publishing anything, and without the hooks. Posted as a comment and a commit
status of the pull request, printed in the terminal and the summary of the
CI job. Throws a `MergePreviewError` when the release of the merge would fail.

## Parameters

### options?

[`MergePreviewOptions`](../interfaces/MergePreviewOptions.md) = `{}`

## Returns

`Promise`<[`ReleaseReport`](../interfaces/ReleaseReport.md)>
