Skip to content

relizy / RelizyProfile

Interface: RelizyProfile ​

Defined in: packages/relizy/src/types.ts:2144

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

Defined in: packages/relizy/src/types.ts:2180

AI options of the profile


bump? ​

optional bump?: BumpConfig

Defined in: packages/relizy/src/types.ts:2152

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


changelog? ​

optional changelog?: ChangelogConfig

Defined in: packages/relizy/src/types.ts:2156

Changelog options of the profile


description? ​

optional description?: string

Defined in: packages/relizy/src/types.ts:2148

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


prComment? ​

optional prComment?: PrCommentConfig

Defined in: packages/relizy/src/types.ts:2172

PR comment options of the profile


publish? ​

optional publish?: PublishConfig

Defined in: packages/relizy/src/types.ts:2160

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


release? ​

optional release?: ReleaseConfig

Defined in: packages/relizy/src/types.ts:2164

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


safetyCheck? ​

optional safetyCheck?: boolean

Defined in: packages/relizy/src/types.ts:2184

Safety check of the profile


social? ​

optional social?: SocialConfig

Defined in: packages/relizy/src/types.ts:2168

Social media options of the profile


sync? ​

optional sync?: SyncConfig

Defined in: packages/relizy/src/types.ts:2176

Branch sync options of the profile