Release Skill
Use this skill to create and publish a new release for the Obsidian plugin.
Steps
- •
Bump Version
- •Read current version from
manifest.json - •Increment version number appropriately (patch/minor/major)
- •Update
manifest.jsonwith new version - •Update
versions.jsonwith new version mapping to minimum Obsidian version
- •Read current version from
- •
Build the Plugin
- •Run
npm run buildto ensure clean compilation - •Verify no TypeScript errors
- •Run
- •
Create Git Commit
- •Stage changes:
manifest.json,versions.json, and any feature files - •Create commit with descriptive message following format:
code
feat: <brief description> <detailed description of changes> Changes: - List of key changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- •Stage changes:
- •
Create and Push Tag
- •Create annotated tag:
git tag -a <version> -m "Release version <version>: <description>" - •Push commits:
git push - •Push tag:
git push origin <version>
- •Create annotated tag:
- •
Wait for Release Workflow
- •Check workflow status:
gh run list --limit 5 - •Wait for "Release Obsidian plugin" workflow to complete successfully
- •Check workflow status:
- •
Update Release
- •View release:
gh release view <version> - •Mark as pre-release and add notes:
bash
gh release edit <version> --prerelease --notes "<release notes>"
- •Release notes format:
markdown
## 🎯 <Feature Title> **Brief description** - Single bullet point per feature describing the feature for users --- **Full Changelog**: https://github.com/<user>/<repo>/compare/<prev-version>...<version>
- •View release:
Example Usage
User: "Can you create a release for the new autocomplete feature?"
Assistant will:
- •Determine appropriate version bump
- •Update manifest and versions files
- •Build to verify
- •Commit changes with detailed message
- •Create and push git tag
- •Monitor workflow completion
- •Mark as pre-release with concise user-facing notes
Notes
- •Always verify the build succeeds before committing
- •Use semantic versioning (MAJOR.MINOR.PATCH)
- •Keep release notes user-focused and concise
- •Mark releases as pre-release by default for testing