Skip to content

UpdateVersionOptions

Options for updateVersion: the generic release options plus the plugin’s own.

Import:

import type { UpdateVersionOptions } from '@mnaoumov/obsidian-dev-toolkit/version';

Signature:

export interface UpdateVersionOptions extends GenericUpdateVersionOptions

Extends: GenericUpdateVersionOptions

Properties

PropertyTypeDescription
minAppVersion?string | undefinedAn explicit minAppVersion to write into the plugin's manifest.json and its new versions.json entry. When set, it is used verbatim and the latest Obsidian desktop version is not fetched at all.

Set this when the plugin has a known minimum it actually requires, rather than tracking whatever Obsidian released most recently. Only applies to non-pre-release versions (a pre-release copies the existing manifest.json and never writes minAppVersion).
shouldArchiveDemoVault?booleanWhether to archive the plugin's demo vault (demo-vault/ in the repo root) as a release artifact. Ignored when the repo has no demo-vault/ folder.

Links to this page: