Skip to content

relizy / previewRelease

Function: previewRelease() ​

previewRelease(options?): Promise<ReleasePreview>

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

What relizy release would do now, as data and without writing anything: for each set of packages (the project, or each version group) the versions before and after, the type of the bump, the commits and the reason of each released package (commits, bumped dependency, peer range, graduation...), the tags, the steps that would run, and with checks what would make the release fail. No hook runs, nothing is asked, and the network is only used with fetchTags, checks and changelog.contributors. The profile, the config and the overrides apply as in release().

Parameters ​

options? ​

PreviewReleaseOptions = {}

Returns ​

Promise<ReleasePreview>

Example ​

ts
const preview = await previewRelease({ profile: 'beta' })
for (const set of preview.sets) {
  console.log(set.title, set.oldVersion, '->', set.newVersion)
}