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

# Interface: MergePreviewPullRequest

Defined in: [packages/relizy/src/core/merge-preview/context.ts:13](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/merge-preview/context.ts#L13)

The pull/merge request a CI job previews, read from the environment of the
job: GitHub Actions (`pull_request` events) and GitLab CI (merge request
pipelines).

## Properties

### body?

> `optional` **body?**: `string`

Defined in: [packages/relizy/src/core/merge-preview/context.ts:22](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/merge-preview/context.ts#L22)

Description: the body of a squash merge on GitHub, with the `PR_BODY` setting

***

### headSha?

> `optional` **headSha?**: `string`

Defined in: [packages/relizy/src/core/merge-preview/context.ts:26](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/merge-preview/context.ts#L26)

Last commit of the pull request, when the CI gives it

***

### kind

> **kind**: `"merge request"` | `"pull request"`

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

`pull request` on GitHub, `merge request` on GitLab

***

### number?

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

Defined in: [packages/relizy/src/core/merge-preview/context.ts:18](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/merge-preview/context.ts#L18)

Number of the pull request, IID of the merge request

***

### provider

> **provider**: `"github"` | `"gitlab"`

Defined in: [packages/relizy/src/core/merge-preview/context.ts:14](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/merge-preview/context.ts#L14)

***

### targetBranch

> **targetBranch**: `string`

Defined in: [packages/relizy/src/core/merge-preview/context.ts:24](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/merge-preview/context.ts#L24)

Branch the pull request merges into

***

### title?

> `optional` **title?**: `string`

Defined in: [packages/relizy/src/core/merge-preview/context.ts:20](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/merge-preview/context.ts#L20)

Title, without the draft marker of GitLab: the commit message of a squash merge
