---
url: https://relizy.dev/typedoc/interfaces/ReleaseReport.md
---
[relizy](../index.md) / ReleaseReport

# Interface: ReleaseReport

Defined in: [src/core/release-report.ts:89](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L89)

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`](ReleaseAI.md)

Defined in: [src/core/release-report.ts:117](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L117)

***

### canary

> **canary**: `boolean`

Defined in: [src/core/release-report.ts:100](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L100)

***

### content?

> `optional` **content?**: [`ReleaseContent`](ReleaseContent.md)

Defined in: [src/core/release-report.ts:114](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L114)

***

### dryRun

> **dryRun**: `boolean`

Defined in: [src/core/release-report.ts:99](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L99)

***

### error?

> `optional` **error?**: `string`

Defined in: [src/core/release-report.ts:118](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L118)

***

### git?

> `optional` **git?**: [`ReleaseGit`](ReleaseGit.md)

Defined in: [src/core/release-report.ts:115](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L115)

***

### publish?

> `optional` **publish?**: [`ReleasePublish`](ReleasePublish.md)

Defined in: [src/core/release-report.ts:116](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L116)

***

### release?

> `optional` **release?**: [`ReleaseOverview`](ReleaseOverview.md)

Defined in: [src/core/release-report.ts:104](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L104)

The packages and versions of the release, by version group

***

### released

> **released**: `boolean`

Defined in: [src/core/release-report.ts:98](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L98)

True when the release happened: never in dry-run

***

### status

> **status**: `"failed"` | `"nothing"` | `"released"`

Defined in: [src/core/release-report.ts:94](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L94)

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

***

### steps

> **steps**: [`ReleaseStepReport`](ReleaseStepReport.md)\[]

Defined in: [src/core/release-report.ts:113](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L113)

The steps run after the bump, in order

***

### tags

> **tags**: `string`\[]

Defined in: [src/core/release-report.ts:109](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L109)

***

### version?

> `optional` **version?**: `string`

Defined in: [src/core/release-report.ts:108](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/core/release-report.ts#L108)

The repository version (`unified`/`selective`)