插件市场帮助文档
插件市场帮助文档
插件市场旨在为插件开发者提供一个插件托管展示平台，方便插件开发者对插件生命周期进行管理，并方便其他用户使用插件。
插件市场插件元数据及生命周期管理规范
插件元数据规范
上传至插件市场的CodeArts IDE Online和 CodeArts IDE插件必须遵循以下的元数据规范：
| 字段名 | 是否必需 | 描述 | 限制 |
|---|---|---|---|
| name | Y | 插件名 | 1. 长度<50 2. 仅允许包含’a-z’，‘A-Z’，‘0-9’，’-’，’_’ 3. 以大小写字母开头 |
| publisher | Y | 发布者， {name}是每个插件的唯一标识id | String，长度<50 |
| version | Y | 版本号 | 遵循Semver规范 |
| icon | 插件图标路径 | 为空的情况下展示默认图标 | |
| license | 许可证文件 | String | |
| displayName | 插件在插件市场中的展示名称 | String，长度<100 | |
| description | 插件描述 | String，长度<1000 | |
| categories | 插件分类集合，插件市场可按分类搜索到该插件 | String[]，最多允许10个，允许值[Programming Languages, Snippets, Linters, Themes, Debuggers, Formatters, Keymaps, SCM Providers, Other, Extension Packs, Language Packs, Data Science, Machine Learning, Visualization, Notebooks, Education] | |
| keywords | 插件关键词集合，插件市场会以标签形式展示 | String[]，最多允许10个,每个关键字长度限制为20 | |
| extensionPack | 该插件集合里包含的插件id数组，安装时数组内的插件将一并安装 | String[] | |
| extensionDependencies | 当前插件依赖的插件id数组，安装时也一并安装 | String[] | |
| preview | 在插件市场中标记为预览插件 | boolean | |
| homepage | 插件首页 | String | |
| repository | 仓库地址 | {type, url} | |
| bugs | 问题单地址 | {url} |
插件生命周期管理规范
插件市场操作指南
为方便插件开发者协作开发与管理，插件市场引入了发布商模型，开发者可以根据自身需要对插件进行权限管控。
发布商管理
发布商是插件开发者们在插件市场的一个身份标识，它是唯一的，同时也标识了插件的归属。开发者可以自行创建发布商，也可以调整发布商在插件市场的展示信息。
发布商创建
插件开发者若要在插件市场发布插件，必须先在插件市场创建相应的发布商。发布商一旦创建，禁止删除，且发布商的唯一标识不可包含huawei字样。
发布商修改
发布商创建后，可以修改发布商信息，但不可修改唯一标识。
发布商成员管理
发布商可以管理其下的相关成员，并为其设置相应的角色，方便进行权限管控。
发布商成员角色
- 发布商成员角色分为以下四种，Owner可以根据自身需要调整成员角色:
| 角色 | 职责 |
|---|---|
| Owner | 拥有发布商和插件管理的所有权限 |
| Manager | 拥有插件审核相关权限（审核功能暂未上线） |
| Developer | 拥有插件发布相关权限，用户可以上传、管理插件 |
| Reader | 拥有插件查看相关权限，不可上传插件 |
- 发布商功能与角色对应关系
| 特性 | 功能 | Reader（发布商普通成员） | Developer（发布商插件开发者） | Manager（发布商插件审核员） | Owner（发布商管理员） | |
| 发布商管理人员可见 | 发布商基础信息管理 | 修改发布商信息 | N | N | N | Y |
| 查看发布商信息 | Y | Y | Y | Y | ||
| 发布商成员管理 | 添加人员，设置角色 | N | N | N | Y | |
| 删除人员 | N | N | N | Y | ||
| 发布商插件管理 | 插件上传 | N | Y | Y | Y | |
| 查看发布商插件列表 | Y | Y | Y | Y | ||
| 查看插件详情 | Y | Y | Y | Y | ||
| 修改插件基础信息 | N | Y | Y | Y | ||
| 插件版本管理 | N | Y | Y | Y | ||
| 查看插件操作记录 | Y | Y | Y | Y | ||
| 插件度量数据看板 | Y | Y | Y | Y | ||
| 发布商凭证管理 | 查询凭证 | N | Y | Y | Y | |
| 创建凭证 | N | Y | Y | Y | ||
| 编辑凭证 | N | Y | Y | Y | ||
| 撤销凭证 | N | Y | Y | Y |
查看成员
发布商成员可以查看当前发布商下的成员列表及其对应的角色。发布商创建者默认为此发布商的owner。
添加成员
发布商owner可以添加成员。点击新增成员按钮，输入对应成员信息，选择对应角色即可。
Tips: 添加未登录过插件市场的成员，将无法展示其用户名。
删除成员
发布商owner可以删除成员。
调整成员角色
发布商owner可以调整其他成员的角色。
发布商插件管理
插件市场将插件按照不同的发布商进行分类，方便插件开发者进行管理
发布插件
在插件市场页面发布插件
用户需先进入发布商管理界面，然后选择/创建对应插件发布商，点击上传插件按钮，开始插件发布流程。
使用IDE客户端和发布商凭证发布插件，具体步骤可见：CodeArts IDE插件开发指南
正式/灰度发布
插件开发者上传插件时可以选择灰度发布或者正式发布。
灰度发布与正式发布的差异:
灰度发布：用户上传插件时选择灰度发布，在审核通过后此版本仅灰度成员可见
正式发布：用户上传插件时选择正式发布，在审核通过后此版本所有人可见
插件上传规则限制：
- 成员在发布商中具有发布插件权限（developer/manager/owner三者之一即可）
- 插件包中元数据定义的发布商与上传时选择的发布商唯一标识相同
- 用户上传待审核的新插件数量不能超过5个
- 用户上传待审核版本数不能超过20个
- 当插件版本状态非发布拒绝、灰度拒绝、废弃时，不能上传相同版本
- 上传的插件新版本应大于历史已上线版本
基础信息管理
用户点击插件管理按钮进入发布商管理界面，选择对应发布商即可看到此发布商下的插件。
发布商成员可以对插件的分类和TAG信息进行编辑
版本管理
发布商成员可以对插件版本进行管理。用户在发布商管理页面，选中要管理的插件，进入插件版本管理页面，进行版本管理操作。
版本上线
已下线的插件版本可以重新申请上线，系统审核通过后版本上线，此版本将对所有人可见。
版本下线
已上线的插件版本可以申请下线，系统审核通过后版本下线，此版本将仅自己可见。
终止发布
用户可以终止发布待审核的版本（无需系统审核），被终止的版本将会被废弃，所有人不可见。用户后续可以上传相同版本。
Tips: 灰度发布和正式发布均可以终止
终止灰度
灰度发布版本可以终止发布（无需系统审核），该版本将直接废弃，所有人不可见。
Tips: 插件版本一旦正式发布，不能终止，只能申请下线。
灰度转正式
灰度已发布版本可以申请正式发布，无需审核，该版本将自动变为正式版本，所有人可见。
灰度插件管理
用户若是某插件灰度版本的灰度用户中，可以在插件市场首页/灰度管理看到此插件。
点击更多进入灰度管理页面，查看所有的灰度插件。
灰度成员管理
灰度插件默认仅插件管理人员可见，用户可以添加灰度成员，针对部分用户可见。目前插件灰度成员最大数量限制为500。
添加灰度成员后，该成员可在插件市场首页看到此插件。
退出灰度
点击灰度插件进入插件详情页面，切换至版本页面，选择对应灰度版本退出此版本的灰度测试。
发布商凭证的创建、编辑、删除
拥有Developer及以上权限的用户，可以在当前发布商下创建发布商凭证
凭证创建
输入凭证名称，并设置过期时间，最长过期时间为1年，凭证过期后则不能再使用此凭证上传插件。
创建凭证成功之后，请妥善保存发布商凭证，关闭窗口后将无法再次获得此凭证。如果没有复制到此凭证，需要撤销或者重新创建凭证。
凭证撤销
凭证撤销后，页面将不再显示撤销的凭证数据，也不能再使用此凭证上传插件。
批量撤销凭证
凭证刷新
如果凭证过期，可通过刷新功能对过期时间进行编辑，编辑成功后将会生成一串新的凭证，历史凭证数据会被置为无效，无法再使用历史凭证上传插件。
- 点赞
- 收藏
- 关注作者
评论（0）