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?
optionalcanary?: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
falseInherited from
changelog?
optionalchangelog?: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?
optionalchecks?: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?
optionalconfig?: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
configName?
optionalconfigName?:string
Defined in: packages/relizy/src/types.ts:1168
Default
'relizy'Inherited from
cwd?
optionalcwd?:string
Defined in: packages/relizy/src/core/release-preview.ts:137
Root of the project, process.cwd() by default
fetchTags?
optionalfetchTags?: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?
optionalforce?:boolean
Defined in: packages/relizy/src/types.ts:1209
Bump even if there are no commits
Default
falseInherited from
from?
optionalfrom?:string
Defined in: packages/relizy/src/types.ts:1155
Inherited from
groups?
optionalgroups?:string[]
Defined in: packages/relizy/src/types.ts:1249
Only process these version groups (monorepo.groups), by name.
Default
all groupsInherited from
overrides?
optionaloverrides?: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
preid?
optionalpreid?:string
Defined in: packages/relizy/src/types.ts:529
Prerelease identifier (e.g. 'beta', 'alpha')
Inherited from
profile?
optionalprofile?: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
suffix?
optionalsuffix?: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
to?
optionalto?:string
Defined in: packages/relizy/src/types.ts:1158
Inherited from
type?
optionaltype?:BumpReleaseType
Defined in: packages/relizy/src/types.ts:525
Release type (e.g. 'major', 'minor', 'patch', 'prerelease', 'prepatch', 'preminor', 'premajor')
Default
'release'