跳至主要內容

发布插件

发布插件

您可以将插件打包、并通过上传到插件插件仓库或私下分享等方式分发您的插件。

打包插件

上架到插件市场

相关信息

这里的插件市场指应用内置的插件源。

上架插件市场的插件必须满足以下条件：

  • 插件内容符合相关法律法规，无涉黄、涉政等敏感内容。
  • 插件是符合开源定义，并有开源许可证的开源项目。
  • 代码存储库托管于 GitHub 上。

不符合以上条件的插件仍然能在本项目的插件 SDK 的开源许可（LGPLv3）下以其它形式自由分发，但不能上架插件市场。

要将插件上架到插件市场，您需要在在原来的插件清单的基础上，补充相关信息，并将补充后的插件清单文件上传到插件源仓库中。

以下是需要补充的信息：

属性名类型必填？说明示例
repoOwnerstring是插件的 GitHub 仓库所有者ClassIsland
repoNamestring是插件的 GitHub 仓库名称ExamplePlugins
assetsRootstring是插件的资源根目录，格式为<默认分支>/<插件项目相对存储库的路径>master/ExamplePlugin
artifactNamestring否指定插件 Release 中给用户要下载的插件包的工件名称，否则索引生成器将匹配第一个以.cipx为后缀的工件plugin.cipx
tagPatternstring否查找最新发行版时要匹配的 Tag 模式。如果设置，将查找匹配符合这个模式的 Tag，否则将使用最新的符合格式的 Tag1.*.**

例如：

classisland.example.yml
id: classisland.example
name: 示例插件
description: 插件描述
entranceAssembly: "ClassIsland.ExamplePlugin.dll"
url: https://github.com/ClassIsland/ClassIsland
repoOwner: ClassIsland
repoName: ExamplePlugins
assetsRoot: master/HelloWorldPlugin
artifactName: plugin.cipx
tagPattern: 1.*.**

您还需要将打包后的插件上传到您的插件的仓库的 Release 中，并添加 MD5 校验信息。

注

如果您使用了一键打包，默认情况下已自动生成 MD5 校验信息，可以跳过此步骤。

补充后的插件清单文件需要重命名为插件 id，并上传到插件源仓库根目录下的index/plugins-v2文件夹中。

注

您按照本方法上架的插件只会出现在 2.x 的插件市场中。要了解如何将您的插件上架到 1.x 的插件市场，请见下文。

上传完成后，需要向源仓库发起 PR。您的插件将被审核，插件审核通过后即可进入插件市场。相关的下载信息将根据插件清单中的信息添加到插件源中。

同时发布兼容 ClassIsland 1.x 和 ClassIsland 2.x 的插件

您可以在将您的插件清单文件添加到 2.x 插件索引目录index/plugins-v2的同时将您的插件索引清单文件添加到 1.x 的索引目录index/plugins中，实现同时在 1.x 和 2.x 的插件市场上架您的插件。

如果您同时在 Releases 中发布了面向 2.x 版本的 ClassIsland 插件，为了在 1.x 的版本的 ClassIsland 插件市场中下载到支持 1.x ClassIsland 版本的插件，您可能也需要在 1.x 插件索引中的插件清单中指定 tagPattern 属性，告诉索引生成器要使用的 Release。例如：

classisland.example.yml
id: classisland.example
name: 示例插件
description: 插件描述
entranceAssembly: "ClassIsland.ExamplePlugin.dll"
url: https://github.com/ClassIsland/ClassIsland
repoOwner: ClassIsland
repoName: ExamplePlugins
assetsRoot: master/HelloWorldPlugin
artifactName: plugin.cipx
tagPattern: 1.*.**

在这个清单文件中我们设置了 1.*.** 的 Tag 模式，这样生成索引的时候就会使用符合这个模式的 Tag 的 Release，用户从 1.x 的插件市场中下载插件时就会从这个 Release 下载。

同理，如果有需要，我们也可以为添加到 2.x 版本的插件索引的清单文件规定要使用的 Release 的 Tag 模式。