UpdateChangelogOptions
Options for updateChangelog.
Import:
import type { UpdateChangelogOptions } from 'obsidian-dev-utils/script-utils/version';Signature:
export interface UpdateChangelogOptionsProperties
| Property | Type | Description |
|---|---|---|
| changelogFilePath? | 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. |
| shouldEditChangelog? | boolean | Whether to open the generated changelog in the editor for an interactive review. When false, the changelog is still generated from commit messages, but it is not opened in the editor for manual review.Ignored when changelogFilePath is set. |
Links to this page: