Skip to content

relizy / PreviewReleaseOptions

Interface: PreviewReleaseOptions ​

Defined in: packages/relizy/src/core/release-preview.ts:135

Extends ​

  • Pick<ReleaseOptions, "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

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.canary


changelog? ​

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

Defined in: packages/relizy/src/core/release-preview.ts:143

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

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


config? ​

optional config?: ResolvedRelizyConfig

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

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.config


configName? ​

optional configName?: string

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

Default ​

ts
'relizy'

Inherited from ​

ReleaseOptions.configName


cwd? ​

optional cwd?: string

Defined in: packages/relizy/src/core/release-preview.ts:137

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


fetchTags? ​

optional fetchTags?: boolean

Defined in: packages/relizy/src/core/release-preview.ts:139

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

Bump even if there are no commits

Default ​

ts
false

Inherited from ​

ReleaseOptions.force


from? ​

optional from?: string

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

Inherited from ​

ReleaseOptions.from


groups? ​

optional groups?: string[]

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

Only process these version groups (monorepo.groups), by name.

Default ​

ts
all groups

Inherited from ​

ReleaseOptions.groups


overrides? ​

optional overrides?: RelizyConfigOverrides

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

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.overrides


preid? ​

optional preid?: string

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

Prerelease identifier (e.g. 'beta', 'alpha')

Inherited from ​

BumpConfig.preid


profile? ​

optional profile?: string

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

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.profile


suffix? ​

optional suffix?: string

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

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.suffix


to? ​

optional to?: string

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

Inherited from ​

ReleaseOptions.to


type? ​

optional type?: BumpReleaseType

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

Release type (e.g. 'major', 'minor', 'patch', 'prerelease', 'prepatch', 'preminor', 'premajor')

Default ​

ts
'release'

Inherited from ​

BumpConfig.type