How cyanvoxel/obsidian-releases works
Main Components
a) Central Repository Components:
• JSON Registry Files (community-plugins.json, community-css-themes.json)
• Release Tracking (desktop-releases.json)
• Plugin Statistics (community-plugin-stats.json)
• Deprecation Registry (community-plugin-deprecation.json)
b) External Components:
• GitHub Platform
• Obsidian Client Application
• Plugin/Theme Developer Repositories
• GitHub Actions Workflow System
┌─────────────────────┐ ┌──────────────────┐
• Obsidian Client │ │ Developer Repos │
• ┘ └──────────────────┘
┌─────────────────────────────────────────┐
• GitHub Actions │
• (Validation, Stats, Release Tracking) │
• ┘
┌─────────────────────────────────────────┐
• JSON Registry Files │
• (Plugins, Themes, Stats, Releases) │
• ┘
Key Processes to Highlight
a) Plugin/Theme Submission Process:
Developer Repo → Pull Request → GitHub Actions Validation → Registry Update
b) Distribution Process:
Registry Files → Obsidian Client → End User Installation
c) Statistics Collection:
Plugin Usage → Stats Collection → Stats JSON Update
Additional Elements
• Plugin validation workflow
• Theme validation workflow
• Release tracking system
• Deprecation handling
Important Notes
• Clear separation between submission and distribution flows
• Automated validation processes
• Version compatibility checking system
• Interaction with GitHub releases for actual file distribution
Technical Details
• File format requirements (manifest.json, README.md)
• Version compatibility checking
• Release tag requirements
• Required file components (main.js, styles.css)
• Plugin/theme submission
• Validation processes
• Distribution mechanisms
• Version management
• Statistics tracking