Skip to content

relizy / ReleasePreview

Interface: ReleasePreview ​

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

Properties ​

canary ​

canary: boolean

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

A canary release (release.canary)


changelogs ​

changelogs: PreviewChangelog[]

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

The changelog entries of the release, with changelog: true


problems ​

problems: MergePreviewProblem[]

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

What would make the release fail (version or tag already taken...), with checks: true


profile? ​

optional profile?: string

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

The profile applied


released ​

released: boolean

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

True when at least one package is released


sets ​

sets: PreviewSet[]

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

One set for the project, one per version group with monorepo.groups


steps ​

steps: PreviewStep[]

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

Every step of relizy release in its order, with whether it runs


tags ​

tags: string[]

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

The git tags the release creates


versionMode ​

versionMode: "groups" | VersionMode | "standalone"

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

The version mode of the project, groups with monorepo.groups (each set has its own)


warnings ​

warnings: string[]

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

What could not be checked, and the warnings of the computation