relizy / MergePreviewOptions
Interface: MergePreviewOptions
Defined in: packages/relizy/src/commands/merge-preview.ts:16
The options of relizy merge-preview: the options of the release job it previews (they decide the versions, the tags and the dist-tag), and the outputs of the preview
Extends
Pick<ReleaseOptions,"type"|"preid"|"suffix"|"from"|"to"|"force"|"publish"|"commit"|"gitTag"|"providerRelease"|"registry"|"tag"|"token"|"publishToken"|"privatePackages"|"prNumber"|"logLevel"|"configName"|"profile"|"config"|"overrides"|"onProgress"|"groups"|"report"|"prCommentMode">
Properties
changelog?
optionalchangelog?:boolean
Defined in: packages/relizy/src/commands/merge-preview.ts:38
Generate the changelog entries of the release (mergePreview.changelogs of the report), without the hooks
Default
falsecheck?
optionalcheck?:boolean|"auto"
Defined in: packages/relizy/src/commands/merge-preview.ts:28
Override of mergePreview.check for this run (off by default, auto: on GitHub only). With comment: false too, the preview is only computed: nothing is posted on the pull request. The report is still written where release.report says (in GitHub Actions: the outputs and the summary of the job, unless release.report.github: false)
comment?
optionalcomment?:boolean
Defined in: packages/relizy/src/commands/merge-preview.ts:21
Override of mergePreview.comment for this run
commit?
optionalcommit?:boolean
Defined in: packages/relizy/src/types.ts:1083
Commit changes and create tag
Default
trueInherited from
commitlint?
optionalcommitlint?:boolean|"auto"
Defined in: packages/relizy/src/commands/merge-preview.ts:33
Override of mergePreview.commitlint for this run (off by default): true lints the commits of the pull request, as warnings
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
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
gitTag?
optionalgitTag?:boolean
Defined in: packages/relizy/src/types.ts:1119
Create tag
Default
trueInherited 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
logLevel?
optionallogLevel?:RelizyLogLevel
Defined in: packages/relizy/src/types.ts:1164
Inherited from
onProgress?
optionalonProgress?:RelizyEventListener
Defined in: packages/relizy/src/types.ts:1179
Called with each event of the run (steps started, done, failed or skipped, progress, links, logs, the end): the same events as RELIZY_REPORTER=json, for a program following the run. A listener that throws does not stop the run.
Inherited 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
prCommentMode?
optionalprCommentMode?:PrCommentMode
Defined in: packages/relizy/src/types.ts:1261
Override of prComment.mode for this run
Inherited from
preid?
optionalpreid?:string
Defined in: packages/relizy/src/types.ts:529
Prerelease identifier (e.g. 'beta', 'alpha')
Inherited from
privatePackages?
optionalprivatePackages?:PrivatePackages
Defined in: packages/relizy/src/types.ts:1235
Override of monorepo.privatePackages: release releases the private packages too
Inherited from
ReleaseOptions.privatePackages
prNumber?
optionalprNumber?:number
Defined in: packages/relizy/src/types.ts:1231
Override PR/MR number for PR comment features
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
providerRelease?
optionalproviderRelease?:boolean
Defined in: packages/relizy/src/types.ts:1098
Publish release to your repository (github or gitlab)
Default
trueInherited from
publish?
optionalpublish?:boolean
Defined in: packages/relizy/src/types.ts:1103
Publish release to your registry
Default
trueInherited from
publishToken?
optionalpublishToken?:string
Defined in: packages/relizy/src/types.ts:1227
NPM token (e.g. "123456")
Inherited from
registry?
optionalregistry?:string
Defined in: packages/relizy/src/types.ts:922
NPM registry URL (e.g. https://registry.npmjs.org/). Without it, the registry of the npm config (.npmrc), unless registries is set: the packages then go only to the declared registries
Inherited from
report?
optionalreport?:ReleaseReportConfig
Defined in: packages/relizy/src/types.ts:1144
Report of the release, to run something only when a release happens: the outputs and the summary of GitHub Actions, a JSON file, a dotenv file (GitLab CI). Written in dry-run too, where released is false.
Default
{ github: true }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
tag?
optionaltag?:string
Defined in: packages/relizy/src/types.ts:926
NPM tag (e.g. latest)
Inherited from
to?
optionalto?:string
Defined in: packages/relizy/src/types.ts:1158
Inherited from
token?
optionaltoken?:string
Defined in: packages/relizy/src/types.ts:1161
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'