Skip to content

UpdateChangelogOptions.changelogFilePath?

UpdateChangelogOptions › changelogFilePath?

Type: string | undefined

A path to a file whose contents become the body of the new version's changelog section, instead of the bullets derived from the commit messages. Use it to supply prepared release notes from a non-interactive caller (a background process, CI, an agent).

Setting it implies no interactive review: the commit log is not read, and the changelog is never opened in the editor nor waited on at the console, regardless of shouldEditChangelog.