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

# Interface: ReleasePreview

Defined in: [packages/relizy/src/core/release-preview.ts:112](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L112)

## Properties

### canary

> **canary**: `boolean`

Defined in: [packages/relizy/src/core/release-preview.ts:116](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L116)

A canary release (`release.canary`)

***

### changelogs

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

Defined in: [packages/relizy/src/core/release-preview.ts:132](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L132)

The changelog entries of the release, with `changelog: true`

***

### problems

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

Defined in: [packages/relizy/src/core/release-preview.ts:128](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L128)

What would make the release fail (version or tag already taken...), with `checks: true`

***

### profile?

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

Defined in: [packages/relizy/src/core/release-preview.ts:114](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L114)

The profile applied

***

### released

> **released**: `boolean`

Defined in: [packages/relizy/src/core/release-preview.ts:120](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L120)

True when at least one package is released

***

### sets

> **sets**: [`PreviewSet`](PreviewSet.md)\[]

Defined in: [packages/relizy/src/core/release-preview.ts:122](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L122)

One set for the project, one per version group with `monorepo.groups`

***

### steps

> **steps**: [`PreviewStep`](PreviewStep.md)\[]

Defined in: [packages/relizy/src/core/release-preview.ts:126](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L126)

Every step of `relizy release` in its order, with whether it runs

***

### tags

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

Defined in: [packages/relizy/src/core/release-preview.ts:124](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L124)

The git tags the release creates

***

### versionMode

> **versionMode**: `"groups"` | [`VersionMode`](../type-aliases/VersionMode.md) | `"standalone"`

Defined in: [packages/relizy/src/core/release-preview.ts:118](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L118)

The version mode of the project, `groups` with `monorepo.groups` (each set has its own)

***

### warnings

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

Defined in: [packages/relizy/src/core/release-preview.ts:130](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L130)

What could not be checked, and the warnings of the computation
