Skip to content

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? ​

optional changelog?: 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 ​

ts
false

check? ​

optional check?: 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? ​

optional comment?: boolean

Defined in: packages/relizy/src/commands/merge-preview.ts:21

Override of mergePreview.comment for this run


commit? ​

optional commit?: boolean

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

Commit changes and create tag

Default ​

ts
true

Inherited from ​

ReleaseConfig.commit


commitlint? ​

optional commitlint?: 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? ​

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


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


gitTag? ​

optional gitTag?: boolean

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

Create tag

Default ​

ts
true

Inherited from ​

ReleaseConfig.gitTag


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


logLevel? ​

optional logLevel?: RelizyLogLevel

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

Inherited from ​

ReleaseOptions.logLevel


onProgress? ​

optional onProgress?: 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 ​

ReleaseOptions.onProgress


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


prCommentMode? ​

optional prCommentMode?: PrCommentMode

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

Override of prComment.mode for this run

Inherited from ​

ReleaseOptions.prCommentMode


preid? ​

optional preid?: string

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

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

Inherited from ​

BumpConfig.preid


privatePackages? ​

optional privatePackages?: PrivatePackages

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

Override of monorepo.privatePackages: release releases the private packages too

Inherited from ​

ReleaseOptions.privatePackages


prNumber? ​

optional prNumber?: number

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

Override PR/MR number for PR comment features

Inherited from ​

ReleaseOptions.prNumber


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


providerRelease? ​

optional providerRelease?: boolean

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

Publish release to your repository (github or gitlab)

Default ​

ts
true

Inherited from ​

ReleaseConfig.providerRelease


publish? ​

optional publish?: boolean

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

Publish release to your registry

Default ​

ts
true

Inherited from ​

ReleaseConfig.publish


publishToken? ​

optional publishToken?: string

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

NPM token (e.g. "123456")

Inherited from ​

ReleaseOptions.publishToken


registry? ​

optional registry?: 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 ​

PublishConfig.registry


report? ​

optional report?: 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 ​

ts
{ github: true }

Inherited from ​

ReleaseConfig.report


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


tag? ​

optional tag?: string

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

NPM tag (e.g. latest)

Inherited from ​

PublishConfig.tag


to? ​

optional to?: string

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

Inherited from ​

ReleaseOptions.to


token? ​

optional token?: string

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

Inherited from ​

ReleaseOptions.token


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