api-deploy-obsidian

Automate Obsidian plugin publishing with releases and community PRs.

27|9|Updated Jan 25, 2026
One-click install
npx skills add https://github.com/Leoyishou/personal-ai-company --skill api-deploy-obsidian
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-deploy-obsidian
Source: https://github.com/Leoyishou/personal-ai-company/tree/main/claude-global/skills/api-deploy-obsidian
Command: npx skills add https://github.com/Leoyishou/personal-ai-company --skill api-deploy-obsidian

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the Obsidian plugin publishing workflow end-to-end, reducing manual steps and errors when releasing to the community plugin store.

Core Features & Use Cases

  • Preflight validation: verifies required files (manifest.json, README.md, LICENSE) exist and version fields align, preventing broken releases.
  • Release creation & tagging: builds and publishes GitHub Release for the specified version, including main.js, manifest.json, and optional assets like styles.css.
  • Community submission: submits a PR to obsidianmd/obsidian-releases to register the plugin in the community directory, using official templates.
  • End-to-end workflow: coordinates checks, release artifacts, and PRs to streamline publishing with minimal manual intervention.

Quick Start

Run the full publish workflow to release your Obsidian plugin to the community store.

Frequently Asked Questions about api-deploy-obsidian

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I publish an Obsidian plugin to the community store?

To publish an Obsidian plugin to the community store, you need to create a GitHub release with required artifacts like manifest.json and main.js, then submit a pull request to the obsidianmd/obsidian-releases repository using the official submission template.

What files are required in an Obsidian plugin release?

An Obsidian plugin release requires manifest.json, README.md, and a LICENSE file, along with main.js and optional assets like styles.css. The version fields inside manifest.json must align correctly to prevent broken releases.

How do I automate GitHub release creation and tagging for an Obsidian plugin?

Automating GitHub release creation and tagging for an Obsidian plugin involves coordinating preflight checks, building the release with main.js and manifest.json, and publishing the tagged GitHub Release with minimal manual intervention.

How do I submit a PR to the obsidianmd/obsidian-releases repository?

To submit a PR to the obsidianmd/obsidian-releases repository, you must register your plugin in the community directory by using the official submission templates to ensure compliance with the Obsidian community store requirements.

Can I validate my Obsidian plugin version before creating a GitHub release?

Yes, you can validate your Obsidian plugin before release by running preflight checks that verify required files exist and that version fields in manifest.json align, preventing broken releases from being published.

What is the best way to streamline Obsidian plugin publishing end-to-end?

The best way to streamline Obsidian plugin publishing end-to-end is to use an automated workflow that coordinates preflight validation, GitHub release artifact generation, and community store PR submission, reducing manual steps and errors.