Skip to content

publishGitHubRelease

Publishes a GitHub release for the new version.

Handles the creation of a release and uploading files for either an Obsidian plugin or another project.

Import:

import { publishGitHubRelease } from 'obsidian-dev-utils/script-utils/version';

Signature:

function publishGitHubRelease(newVersion: string, isObsidianPlugin: boolean): Promise<void>

Parameters:

ParameterTypeDescription
newVersionstringThe new version number for the release.
isObsidianPluginbooleanA boolean indicating if the project is an Obsidian plugin.

Returns: Promise<void> — A Promise that resolves when the release has been published.