Obsidian插件发布完整开发者指南：从开发流程到社区上架

Obsidian插件发布完整开发者指南：从开发流程到社区上架

【免费下载链接】remotely-saveremotely-save/remotely-save - 一个非官方的Obsidian同步插件，支持多种云服务，允许用户在本地和云端之间同步Obsidian知识库。项目地址: https://gitcode.com/gh_mirrors/re/remotely-save

🔧 准备阶段：环境与配置准备

开发环境配置

在开始插件开发前，需确保本地环境已安装Node.js（v14+）和npm包管理器。通过以下命令克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/re/remotely-save cd remotely-save npm install

环境变量设置

创建.env文件配置云服务API密钥，包含Dropbox、OneDrive等服务的认证信息。关键环境变量示例：

DROPBOX_APP_KEY=your_dropbox_key ONEDRIVE_CLIENT_ID=your_client_id GOOGLEDRIVE_CLIENT_ID=your_google_client_id

环境变量：存储敏感配置的运行时参数，避免硬编码

元数据配置

修改manifest.json文件设置插件基本信息，核心字段包括：

{ "id": "remotely-save", "name": "Remotely Save", "version": "0.5.25", "minAppVersion": "0.13.21" }

manifest.json：Obsidian插件的元数据文件，包含插件标识和兼容性信息

注意事项

1. 环境变量需与云服务控制台配置保持一致
2. manifest版本号需遵循SemVer规范
3. minAppVersion应设置为支持的最低Obsidian版本

🚀 实施阶段：构建与版本管理

插件构建流程

项目支持Webpack和esbuild两种构建方式，推荐生产环境使用Webpack构建：

# 生产构建（Webpack） npm run build # 开发构建（esbuild） npm run build2

构建成功后会在项目根目录生成三个核心文件：main.js（主程序）、manifest.json（元数据）和styles.css（样式文件）。

版本控制策略

采用SemVer规范进行版本管理，通过npm命令更新版本号并创建Git标签：

# 升级补丁版本（0.5.25 → 0.5.26） npm version patch # 推送标签到远程仓库 git push --tags

注意事项

1. 构建前需执行npm run lint确保代码规范
2. 版本更新需同步修改package.json和manifest.json
3. 重大更新应在CHANGELOG.md中记录详细变更

✅ 验证阶段：测试与社区上架

功能测试验证

执行测试套件验证核心功能完整性：

npm test

测试覆盖配置持久化、加密功能和元数据管理等关键模块，确保代码质量。

社区发布流程

1. 在GitHub创建新Release，上传构建产物（main.js、manifest.json、styles.css）
2. 填写发布说明，包含版本变更内容和兼容性信息
3. 提交至Obsidian社区插件市场，等待审核通过

注意事项

1. 发布前需在多环境（Windows/macOS/Linux）验证功能
2. 社区提交需提供完整的功能说明和使用文档
3. 保持README.md和使用文档与当前版本同步

🌟 最佳实践建议

1. 持续集成：配置GitHub Actions实现自动构建和测试，确保每次提交的代码质量
2. 版本兼容：采用渐进式功能开发，保持对旧版本Obsidian的向后兼容
3. 用户反馈：建立issue模板和讨论区，及时响应用户问题和功能需求

通过遵循以上流程，可确保Remotely Save插件的稳定发布和可靠运行，为Obsidian用户提供安全高效的多云同步服务。

【免费下载链接】remotely-saveremotely-save/remotely-save - 一个非官方的Obsidian同步插件，支持多种云服务，允许用户在本地和云端之间同步Obsidian知识库。项目地址: https://gitcode.com/gh_mirrors/re/remotely-save