Releases an Obsidian plugin: the generic release from @mnaoumov/typescript-dev-toolkit/version, plus what only a plugin has — manifest.json (and manifest-beta.json for a pre-release) and versions.json bumped with the plugin’s minAppVersion, the updated manifest copied into dist/build, the demo vault archived as a release asset, and the files in dist/build attached to the GitHub release instead of an npm pack tarball.
| Interface |
Description |
| DesktopReleasesJson |
Type representing the structure of Obsidian’s desktop-releases.json feed. This is the feed the desktop app itself updates from, so it is the only source that states a version desktop users can actually run. |
| Manifest |
Type representing the manifest file format for Obsidian plugins. |
| ParsedVersionArguments |
The result of parsing the command-line arguments for a plugin release. |
| UpdateVersionOptions |
Options for updateVersion: the generic release options plus the plugin’s own. |
| Function |
Description |
| copyUpdatedManifest |
Copies the updated manifest file to the distribution build folder. |
| parseVersionArguments |
Parses the command-line arguments for a plugin release: every flag the generic parseVersionArguments recognizes, plus two of the plugin’s own: - --min-app-version=<x.y.z> — write this minAppVersion into the plugin’s manifest.json and its new versions.json entry instead of tracking the latest Obsidian desktop version. - --no-demo-vault — skip archiving the plugin’s demo vault (demo-vault/) as a release artifact. |
| updateVersion |
Releases the plugin. See the @file overview for what it adds to the generic release. |