---
url: https://relizy.dev/typedoc/functions/previewChangelog.md
---
[relizy](../index.md) / previewChangelog

# Function: previewChangelog()

> **previewChangelog**(`options?`): `Promise`<[`PreviewChangelog`](../interfaces/PreviewChangelog.md)\[]>

Defined in: [packages/relizy/src/core/release-preview.ts:655](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L655)

The changelog entries the next release would add, per file (the root `CHANGELOG.md` and
the one of each released package), without writing anything. Same options as
`previewRelease()`, plus `package` for a single package.

## Parameters

### options?

[`PreviewChangelogOptions`](../type-aliases/PreviewChangelogOptions.md) = `{}`

## Returns

`Promise`<[`PreviewChangelog`](../interfaces/PreviewChangelog.md)\[]>

## Example

```ts
const changelogs = await previewChangelog({ profile: 'beta', package: 'root' })
console.log(changelogs[0].content)
```
