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

# Interface: ReleaseReportConfig

Defined in: [src/types.ts:919](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L919)

## Properties

### dotenv?

> `optional` **dotenv?**: `string`

Defined in: [src/types.ts:935](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L935)

File to write the outputs to, as dotenv (`RELIZY_RELEASED=true`...),
for the `artifacts:reports:dotenv` of GitLab CI (relative to `cwd`)

***

### github?

> `optional` **github?**: `boolean`

Defined in: [src/types.ts:926](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L926)

In GitHub Actions, write the outputs of the step (`released`, `status`,
`version`, `tags`, `packages`, `branch`, `commit`, `dist_tags`, `urls`,
`install`, `failed_steps`, `report`, `summary`) and the summary of the run

#### Default

```ts
true
```

***

### json?

> `optional` **json?**: `string`

Defined in: [src/types.ts:930](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L930)

File to write the report to, as JSON (relative to `cwd`)

***

### markdown?

> `optional` **markdown?**: `string`

Defined in: [src/types.ts:940](https://github.com/LouisMazel/relizy/blob/a398e68a47bd63589ac7319ac337d409124d72bb/src/types.ts#L940)

File to write the summary of the release to, as markdown (the summary of
a GitHub Actions run), e.g. for an artifact of GitLab CI (relative to `cwd`)