Skip to main content
Skip to content

在 GitHub 上创建和共享插件市场

发布一个由GitHub托管的市场,以便人们可以在受支持的Copilot客户端中发现和安装插件。

应用市场为支持的 Copilot 客户端分发插件。 它们可以托管在GitHub仓库、另一个 Git 主机或本地目录中。 本文介绍如何在存储库中发布 GitHub 市场项。 有关概述,请参阅“用于 GitHub Copilot 的插件”。

开始之前

  • 创建一个或多个可在用户所使用的客户端中运行的插件。 有关 GitHub Copilot CLI 格式和创作指南,请参阅 为 GitHub Copilot CLI 创建插件。
  • 有关 Visual Studio Code 格式和编写指南,请参阅 代理插件编写参考。
  • 选择稳定的 kebab-case 格式 Marketplace 名称,例如 engineering-tools。 插件标识符包括此名称,因此,更改它会改变人们在设置和命令中使用的标识符。

创建市场仓库

为应用市场创建存储库。 可以从 插件市场入门模板 开始,并按照自述文件安装其开发依赖项并设置市场名称,或自行创建文件。 如果使用模板,请删除不想共享的任何示例插件。

  1. 将 marketplace.json 编目文件添加到 .github/plugin/。
  2. 将每个插件目录添加到其 source 字段所列的路径中。 例如,如果源为 ./plugins/frontend-design,请在存储库中的 plugins/ 下添加 frontend-design 目录。
  3. 为市场的 name 添加稳定的短横线命名值。
  4. 更新 .github/CODEOWNERS、贡献说明以及议题和拉取请求模板,使其符合你希望如何维护 marketplace 的方式。
  5. 如果使用初学者模板,请按照其自述文件运行 npm run verify。 该模板将此命令描述为检查目录清单、清单、测试和评估覆盖范围。 使工作流 .github/workflows/validate.yml 保持启用状态,以便对拉取请求和推送运行无需模型的检查。 检查当前的自述文件和工作流,因为模板检查可能会更改。

marketplace.json 文件是所需的应用商店目录。 它提供市场元数据并列出插件。 顶级 plugins 字段是一组插件条目,其中包含元数据,例如每个插件的名称、说明、版本和源。 有关示例目录,请参阅 在 。

有关支持的目录字段和其他市场文件位置,请参阅 插件与应用市场参考。

查看和维护应用市场

审查作为共享代理基础架构的插件更改。 在发布更新之前测试插件行为,并将评估与其旨在评估的上下文一起保留。 更新存储库时,请查看目录条目和插件源。

分享应用市场

添加市场或接收其插件的人员需要对存储库具有读取访问权限,并且必须在其客户端中登录到 GitHub。 对于专用商城,请在组织中托管它,并向其用户授予访问权限。 仅组织成员身份不能保证访问专用存储库。

发布存储库后,请与需要将其添加到客户端的人员共享其 URL。 还可以通过共享设置提供插件:

延伸阅读