updateChangelog
Updates the changelog file with new version information and commit messages.
This function reads the current changelog, appends new entries for the latest version, and prompts the user to review the changes.
The review happens on a scratch copy in the OS temporary folder, and the repository’s own CHANGELOG.md is written only once the review is over — so interrupting the review leaves the repository untouched.
Import:
import { updateChangelog } from 'obsidian-dev-utils/script-utils/version';Signature:
function updateChangelog(newVersion: string, options: UpdateChangelogOptions): Promise<void>Parameters:
| Parameter | Type | Description |
|---|---|---|
newVersion | string | The new version number to be added to the changelog. |
options | UpdateChangelogOptions | The UpdateChangelogOptions controlling the changelog review behavior. |
Returns: Promise<void> — A Promise that resolves when the changelog update is complete.
Links to this page: