SuperAPI AI 工具集

obsidian-deploy-integration

部署与运维

查看项目

更新于 10-16 06:20

技能介绍

用途:面向 Obsidian 插件作者,提供从构建发布资产到分发上线的完整流程,适用于首次发布插件、更新已有插件以及管理社区插件目录条目。

主要能力:涵盖四条分发渠道——官方社区插件目录、GitHub Releases、BRAT 测试版和手动安装。包括清洁构建、校验发布文件、版本号同步、创建 Release、向 obsidianmd/obsidian-releases 提交 PR 以及处理常见错误。

使用方式:先用 npm ci 与 npm run build 生成 main.js,并确认 main.js 与 manifest.json 存在,样式文件可选。通过 version-bump.mjs 将 npm_package_version 同步到 manifest.json 的 version 和 versions.json(映射每个版本到最低 Obsidian 版本),并把脚本接入 package.json 的 version 脚本。随后用 npm version patch 等触发提交与打标签,再用 gh release create 上传 main.js、manifest.json、styles.css 根级资产。首次提交社区插件需 fork 并克隆 obsidianmd/obsidian-releases,向 community-plugins.json 按 id 字母序插入条目,再创建 PR。测试版可用 npm version prerelease --preid=beta 加 gh release create --prerelease,由 BRAT 安装;手动安装则把文件复制到 .obsidian/plugins/插件目录。

限制:需公开 GitHub 仓库、gh CLI 已认证并通过 obsidian-prod-checklist 校验。审查要求 manifest 字段完整、id 一致、生产代码无 console.log、无 eval 或动态代码执行、无远程运行时加载,移动端兼容时不应设置 isDesktopOnly。

常见问题:安装后不加载多因 manifest 的 id 与目录名不一致;构建缺失多为 esbuild outfile 配置错误;BRAT 找不到发布是因缺少 GitHub Release;gh release create 失败需先 gh auth login。官方文档、插件指南等资源链接已列出,事件处理与预发布校验可参考相关技能。