Skip to content

relizy / ReleaseReport

Interface: ReleaseReport ​

Defined in: src/core/release-report.ts:89

The outcome of relizy release, rendered in the terminal, in the outputs and the summary of GitHub Actions, and in the files of release.report.

Properties ​

ai? ​

optional ai?: ReleaseAI

Defined in: src/core/release-report.ts:117


canary ​

canary: boolean

Defined in: src/core/release-report.ts:100


content? ​

optional content?: ReleaseContent

Defined in: src/core/release-report.ts:114


dryRun ​

dryRun: boolean

Defined in: src/core/release-report.ts:99


error? ​

optional error?: string

Defined in: src/core/release-report.ts:118


git? ​

optional git?: ReleaseGit

Defined in: src/core/release-report.ts:115


publish? ​

optional publish?: ReleasePublish

Defined in: src/core/release-report.ts:116


release? ​

optional release?: ReleaseOverview

Defined in: src/core/release-report.ts:104

The packages and versions of the release, by version group


released ​

released: boolean

Defined in: src/core/release-report.ts:98

True when the release happened: never in dry-run


status ​

status: "failed" | "nothing" | "released"

Defined in: src/core/release-report.ts:94

released: the packages were released, nothing: no commit triggers a bump, failed: the release stopped on an error


steps ​

steps: ReleaseStepReport[]

Defined in: src/core/release-report.ts:113

The steps run after the bump, in order


tags ​

tags: string[]

Defined in: src/core/release-report.ts:109


version? ​

optional version?: string

Defined in: src/core/release-report.ts:108

The repository version (unified/selective)