Skip to content

relizy / previewChangelog

Function: previewChangelog() ​

previewChangelog(options?): Promise<PreviewChangelog[]>

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

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 = {}

Returns ​

Promise<PreviewChangelog[]>

Example ​

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