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

# Interface: ReleaseMergePreview

Defined in: [packages/relizy/src/core/release-report.ts:135](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L135)

## Properties

### branch

> **branch**: `string`

Defined in: [packages/relizy/src/core/release-report.ts:172](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L172)

Branch the release runs on: the target branch, the current one outside a pull request

***

### changelogs?

> `optional` **changelogs?**: [`PreviewChangelog`](PreviewChangelog.md)\[]

Defined in: [packages/relizy/src/core/release-report.ts:188](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L188)

The changelog entries of the release, with the `changelog` option

***

### commitlint

> **commitlint**: [`MergePreviewProblem`](MergePreviewProblem.md)\[]

Defined in: [packages/relizy/src/core/release-report.ts:153](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L153)

The commits of the pull request (and its squash commit) failing the commitlint of the project:
warnings, the release does not lint the commits

***

### markdown

> **markdown**: `string`

Defined in: [packages/relizy/src/core/release-report.ts:158](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L158)

The comment of the pull request and the summary of the CI job

***

### packages

> **packages**: [`MergePreviewPackage`](MergePreviewPackage.md)\[]

Defined in: [packages/relizy/src/core/release-report.ts:176](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L176)

The released packages, with their versions, their reason and their commits (from the pull request or the target branch)

***

### posted

> **posted**: `object`

Defined in: [packages/relizy/src/core/release-report.ts:192](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L192)

The pull request was commented (`comment`), and its commit status set (`check`)

#### comment

> **comment**: `boolean`

#### status

> **status**: `boolean`

***

### problems

> **problems**: [`MergePreviewProblem`](MergePreviewProblem.md)\[]

Defined in: [packages/relizy/src/core/release-report.ts:148](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L148)

What would make the release of the merge fail

***

### publish

> **publish**: `object`

Defined in: [packages/relizy/src/core/release-report.ts:184](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L184)

The release publishes the packages, with this dist-tag

#### distTag

> **distTag**: `string`

#### enabled

> **enabled**: `boolean`

***

### pullRequest?

> `optional` **pullRequest?**: `number`

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

Number of the pull/merge request, none outside a pull request pipeline. The same as
`pullRequestDetails.number`, which also has its branches, its kind and how the merge was computed

***

### pullRequestDetails?

> `optional` **pullRequestDetails?**: [`MergePreviewPullRequest`](MergePreviewPullRequest.md) & `object`

Defined in: [packages/relizy/src/core/release-report.ts:163](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L163)

The pull/merge request detected from the CI job (its `number` is `pullRequest`), and how the
merge was computed. None outside a pull request pipeline

#### Type Declaration

##### merged

> **merged**: `boolean`

HEAD holds the target branch: the preview is the release of the merge

##### warning?

> `optional` **warning?**: `string`

Why HEAD does not hold the target branch

***

### squash?

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

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

How the merge was computed: `squash`, `commits`, or `both` when the merge method is unknown

***

### squashPackages?

> `optional` **squashPackages?**: [`MergePreviewPackage`](MergePreviewPackage.md)\[]

Defined in: [packages/relizy/src/core/release-report.ts:180](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L180)

The packages a squash merge would release, when the merge method is unknown and the squash releases other versions

***

### warnings

> **warnings**: `string`\[]

Defined in: [packages/relizy/src/core/release-report.ts:154](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-report.ts#L154)
