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

# Interface: RelizyProfile

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

A named way of releasing (`beta`, `canary`, `latest`...): config options applied over the
config file when it is selected, with `--profile <name>` or the `profile` option.

The precedence is: defaults, config file, profile, then the options of the run (the
CLI flags, the options of the API).

## Properties

### ai?

> `optional` **ai?**: [`AIConfig`](AIConfig.md)

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

AI options of the profile

***

### bump?

> `optional` **bump?**: [`BumpConfig`](BumpConfig.md)

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

Bump options of the profile, e.g. `{ type: 'prerelease', preid: 'beta' }`

***

### changelog?

> `optional` **changelog?**: [`ChangelogConfig`](ChangelogConfig.md)

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

Changelog options of the profile

***

### description?

> `optional` **description?**: `string`

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

What the profile is for, shown by `relizy` consumers that list the profiles

***

### prComment?

> `optional` **prComment?**: [`PrCommentConfig`](PrCommentConfig.md)

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

PR comment options of the profile

***

### publish?

> `optional` **publish?**: [`PublishConfig`](PublishConfig.md)

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

Publish options of the profile, e.g. `{ tag: 'beta' }`

***

### release?

> `optional` **release?**: [`ReleaseConfig`](ReleaseConfig.md)

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

Release options of the profile, e.g. `{ canary: true }` or `{ social: false }`

***

### safetyCheck?

> `optional` **safetyCheck?**: `boolean`

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

Safety check of the profile

***

### social?

> `optional` **social?**: [`SocialConfig`](SocialConfig.md)

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

Social media options of the profile

***

### sync?

> `optional` **sync?**: [`SyncConfig`](SyncConfig.md)

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

Branch sync options of the profile
