semantic-release-obsidian-plugin

A semantic-release plugin for automating the releases of Obsidian plugins.

Step	Description
verifyConditions	Verify required metadata files are present.
prepare	Update metadata files with new version.

Install

$ npm install brianrodri/semantic-release-obsidian-plugin --save-dev

Usage

The plugin can be configured in the semantic-release configuration file:

{
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "brianrodri/semantic-release-obsidian-plugin"
    ],
    "tagFormat": "${version}"
}

Important

The tagFormat must be set to ${version} to ensure that releases follow Obsidian's versioning scheme.

When semantic-release runs, this plugin will update the following files according to Obsidian's versioning scheme:

• package.json
• package-lock.json
• manifest.json
• versions.json