Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 3.8 KB

publishing.md

File metadata and controls

97 lines (66 loc) · 3.8 KB

发布插件

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

打包插件

:::tabs#pack_method

@tab Powershell Core

在 Powershell Core 中使用以下命令将插件输出/发布目录打包到一个扩展名为.cipx的zip压缩文件中。

Compress-Archive -Path "（你的插件编译输出目录，如 E:\xxx\MyPlugin\bin\Release\net8.0-windows\）" -DestinationPath ./myplugin.cipx

@tab 手动打包

  1. 将您的插件加载到 ClassIsland 中。

  2. 在 ClassIsland 中打开【应用设置】->【插件】。

  3. 选择要打包的插件，点击插件详细界面的【更多选项…（右上角三个点）】，点击【打包插件…】

    1722514478099

    1722514515956

  4. 选择保存插件包的位置。

  5. 打包完成。 :::

上架到插件市场

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

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

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

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

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

以下是需要补充的信息：

属性名 类型 必填？ 说明
RepoOwner string 是 插件的 GitHub 仓库所有者
RepoName string 是 插件的 GitHub 仓库名称
AssetsRoot string 是 插件的资源根目录，格式为<默认分支>/<插件项目相对存储库的路径>，例如master/ExamplePlugin。

例如：

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

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

:::tabs#pack_method

@tab 通过 Powershell

  1. 在此处下载 MD5 计算 Powershell 脚本，并重命名为 generate-md5.ps1
  2. 运行以下命令： 
    ./generate-md5.ps1 打包输出目录
    此命令将运行 MD5 计算脚本，并将符合格式要求的 MD5 校验信息输出到文件 checksums.md 中。
  3. 上传插件包到 Releases，并在发行日志中填入 checksums.md 的内容。

@tab 手动添加

  1. 利用 7z 等工具计算插件包的 MD5。
  2. 上传插件包到 Releases，并按以下格式在发行日志中加入校验信息： 
    <!-- CLASSISLAND_PKG_MD5 {"插件包文件名": "得到的 MD5"} -->
    其中被注释标签包裹的 json 对象是一个以文件名为键，MD5 值为值的字典。如果有多个文件，可以扩充此字典。 :::

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

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