| name | plugin-distribution-standardizer |
| description | 标准化 AutoOps 平台的下载型插件(plugins/ 与 releases/),生成 manifest.yaml、规范目录结构,并确保首页/下载中心可发现与下载 |
插件/安装包标准化 SOP
当用户提到“插件、下载包、release 安装包、plugins 目录、manifest.yaml、下载中心”,或需要把某个 zip/crx/exe/dmg 纳入平台时,使用本技能。
目标:让下载型工具与 deployable 工具并存,但交互不同(下载而非启动)。
目录与命名规范(必须)
插件(Downloadable Plugins):
plugins/
<slug>/
manifest.yaml
files/
<artifact files...>
安装包(Release Installer):
releases/
<slug>/
manifest.yaml
files/
<artifact files...>
要求:
<slug> 使用小写 kebab-case(如 wechatsync)。
- 所有可下载文件必须放入
files/。
manifest.yaml 是唯一必需的描述入口。
manifest.yaml 字段规范(必须)
最小可用 manifest:
name: Example Tool
distribution_type: plugin
version: 1.0.0
short_description: 一句话说明用途
tags: [tag1, tag2]
files:
- files/example-1.0.0.zip
notes: |
安装步骤 / 权限说明 / 常见问题(会显示在详情侧栏 Docs/Install Guide)
推荐字段:
slug: 可省略(系统会以目录名为准)
long_description: 更详细说明
category: 分类数组
browsers(插件): 如 [chrome, edge, firefox]
platforms(安装包): 如 [windows, macos, linux]
source_url: 上游项目地址(如 GitHub README)
标准化步骤(按顺序执行)
- 识别类型
- 插件包(浏览器/本地插件)→ 放到
plugins/
- 安装包(exe/dmg/msi/appimage 等)→ 放到
releases/
- 生成 slug 与目录
- 取项目名生成 slug(kebab-case)
- 创建目录与
files/
- 迁移制品文件
- 将 zip/crx/exe/dmg 移动到
files/ 目录
- 文件名尽量包含版本号
- 生成 manifest.yaml
- 填写最小字段(name/distribution_type/version/short_description/files/notes)
- notes 中写清 SOP(安装步骤/权限说明/常见问题)
- 验证可发现性
- 刷新发现:
POST /api/refresh
- 首页应能看到(类型为 plugin/release)
/downloads 应能看到并下载
针对 README 上游项目的写法建议
short_description:强调“解决什么问题 + 面向谁”
notes:写“用户可直接执行的步骤”,避免长段背景介绍
- 不要复制长 README;只提炼 SOP 与关键注意事项
快速检查清单
- 目录是否为
plugins/<slug>/manifest.yaml 或 releases/<slug>/manifest.yaml
files 字段是否引用 files/ 下真实存在的文件
distribution_type 是否正确
- notes 是否可直接指导安装/使用