micsapp Obsidian Plugin Deploy Integration
Overview
Publish and distribute Obsidian plugins through the official community plugin directory. Covers the complete release workflow: building, versioning, creating GitHub releases, and submitting to the Obsidian community plugins repository for review and listing.
Prerequisites
- Obsidian plugin with
main.ts,manifest.json, andstyles.css(if applicable) - GitHub repository for your plugin
- Node.js build toolchain (esbuild recommended)
- Understanding of Obsidian plugin review requirements
Instructions
Step 1: Configure Build Pipeline
Step 2: Version and Release Files
Step 3: GitHub Release Workflow
Step 4: Submit to Community Plugins
Step 5: Version Bump Script
For full implementation details and code examples, load:
references/implementation-guide.md
Error Handling
| Issue | Cause | Solution |
|---|---|---|
| Plugin not loading | Wrong manifest ID | Ensure id matches directory name |
| Build fails | Missing externals | Add obsidian to esbuild externals |
| Review rejected | Guidelines violation | Review obsidian.md/plugins/guidelines |
| Version mismatch | versions.json outdated | Run version-bump script before release |
Resources
Next Steps
For event handling, see obsidian-webhooks-events.
Output
- Configuration files or code changes applied to the project
- Validation report confirming correct implementation
- Summary of changes made and their rationale
See deployment implementation details for output format specifications.
Examples
Basic usage: Apply obsidian deploy integration to a standard project setup with default configuration options.
Advanced scenario: Customize obsidian deploy integration for production environments with multiple constraints and team-specific requirements.