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

# Interface: PreviewReleaseOptions

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

## Extends

* `Pick`<[`ReleaseOptions`](ReleaseOptions.md), `"configName"` | `"config"` | `"profile"` | `"overrides"` | `"type"` | `"preid"` | `"suffix"` | `"from"` | `"to"` | `"canary"` | `"force"` | `"groups"`>

## Properties

### canary?

> `optional` **canary?**: `boolean`

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

Publish a canary release from the current commit, as `--canary`: a prerelease
version (`bump.preid`, `canary` by default) with the short sha of the commit,
published under the `canary` npm tag (`publish.tag`), without commit, tag,
push, changelog, provider release nor social post.

#### Default

```ts
false
```

#### Inherited from

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

***

### changelog?

> `optional` **changelog?**: `boolean` | { `contributors?`: `boolean`; `package?`: `string`; }

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

Generate the changelog entries (`changelogs`), for every package, or only for `{ package }` ("root" for the root changelog). With `contributors`, the contributors section (may reach the network). Default: false

***

### checks?

> `optional` **checks?**: `boolean`

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

Check what would make the release fail: versions already published, tags already on the remote (network). Default: false

***

### 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)

***

### cwd?

> `optional` **cwd?**: `string`

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

Root of the project, `process.cwd()` by default

***

### fetchTags?

> `optional` **fetchTags?**: `boolean`

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

Run `git fetch --tags` first, as the release does (network). Default: false, the local tags are used

***

### 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)

***

### 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)

***

### 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)

***

### 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)

***

### 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)

***

### 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)

***

### 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)

***

### 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)
