obsidian-plugin-release

Automate Obsidian plugin releases with version bumps, changelogs, builds, and GitHub PRs.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/atman-33/skills --skill obsidian-plugin-release
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-plugin-release
Source: https://github.com/atman-33/skills/tree/main/skills/obsidian/obsidian-plugin-release
Command: npx skills add https://github.com/atman-33/skills --skill obsidian-plugin-release

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the end-to-end release workflow for Obsidian plugins, ensuring version consistency, changelog updates, builds, and GitHub Releases with minimal manual steps.

Core Features & Use Cases

  • Version synchronization across manifest.json, package.json, and versions.json to prevent drift.
  • CHANGELOG automation to create or update release notes in Keep a Changelog format.
  • Build verification to ensure main.js and manifest.json exist post-build (styles.css optional).
  • GitHub integration to create PRs and Releases via the gh CLI for streamlined publishing.
  • Interactive or scripted workflows suitable for initial releases and subsequent version bumps.

Quick Start

Use the interactive workflow or individual scripts to prepare a release:

  • Run interactive workflow: python3 .claude/skills/obsidian-plugin-release/scripts/release_workflow.py
  • Or perform tasks directly, e.g. bump versions, update changelog, build, and publish:
  • python3 scripts/bump_version.py patch [project_root]
  • python3 scripts/update_changelog.py update 1.0.1 owner/repo [project_root]
  • python3 scripts/build_plugin.py [project_root]
  • python3 scripts/create_pr.py feature/core main 1.0.1
  • python3 scripts/create_release.py 1.0.1 --publish [project_root]

Frequently Asked Questions about obsidian-plugin-release

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

FAQPage Schema
How do I automate Obsidian plugin releases on GitHub end-to-end?

Automating Obsidian plugin releases involves coordinating version bumps, changelog generation, build verification, and PR creation via GitHub CLI. This ensures manifest.json, package.json, and versions.json stay synchronized throughout the release workflow.

How do I keep manifest.json, package.json, and versions.json synchronized during a plugin release?

Synchronizing manifest.json, package.json, and versions.json requires automated version bumping during the plugin release. This prevents version drift across files when applying initial releases or subsequent version updates.

Do I need Node and GitHub CLI to automate Obsidian plugin publishing?

Yes, automating Obsidian plugin publishing requires a Node/npm environment to build the project and the GitHub CLI (gh) to create pull requests and releases. These tools ensure the build output and GitHub operations function correctly.

What is the best way to generate a changelog for an Obsidian plugin release?

Generating a changelog for an Obsidian plugin release is best handled by automating updates in Keep a Changelog format. This process creates or updates release notes automatically as part of the version bump and publishing workflow.

How do I verify my Obsidian plugin build before creating a GitHub release?

Verifying an Obsidian plugin build before a GitHub release involves checking that main.js and manifest.json exist post-build, while styles.css remains optional. This build verification ensures the required files are present for publishing.

Can I run individual scripts to bump versions and create GitHub releases for Obsidian plugins?

Yes, you can run individual scripts to bump versions, update changelogs, build, and create GitHub releases for Obsidian plugins. This allows scripted workflows for specific tasks or an interactive workflow for the entire end-to-end process.