跳至主要内容

在 GitHub Marketplace 中发布操作

您可以发布到 GitHub Marketplace,并与 GitHub 社区共享您创建的操作。

您必须接受服务条款才能在 GitHub Marketplace 中发布操作。

关于发布操作

在发布操作之前,您需要在您的存储库中创建操作。有关更多信息,请参阅“共享自动化”。

当您计划将操作发布到 GitHub Marketplace 时,您需要确保存储库仅包含操作所需的元数据文件、代码和文件。为操作创建单个存储库允许您将代码作为一个单元进行标记、发布和打包。GitHub 还使用您 GitHub Marketplace 页面上的操作元数据。

操作会立即发布到 GitHub Marketplace,并且只要它们满足以下要求,就不会由 GitHub 审查

  • 操作必须位于公共存储库中。
  • 每个存储库必须包含单个操作。
  • 每个存储库都不能包含任何工作流文件。
  • 操作的元数据文件(action.ymlaction.yaml)必须位于存储库的根目录中。
  • 操作元数据文件中的name必须唯一。
    • name不能与 GitHub Marketplace 上发布的现有操作名称匹配。
    • name不能与 GitHub 上的用户或组织匹配,除非用户或组织所有者正在发布操作。例如,只有 GitHub 组织才能发布名为github的操作。
    • name不能与现有的 GitHub Marketplace 类别匹配。
    • GitHub 保留 GitHub 功能的名称。

发布操作

您可以通过将创建的操作标记为新版本并发布它来将其添加到 GitHub Marketplace。

要草拟新版本并将操作发布到 GitHub Marketplace,请按照以下说明操作

  1. 在 GitHub 上,导航到存储库的主页。

  2. 导航到存储库中的操作元数据文件(action.ymlaction.yaml),您将看到一个将操作发布到 GitHub Marketplace 的横幅。点击草拟版本

  3. 在“发布操作”下,选择将此操作发布到 GitHub Marketplace

    注意

    如果拥有存储库的帐户尚未接受 GitHub Marketplace 开发者协议,则“发布”复选框将被禁用。如果您拥有存储库或是有组织所有者,请点击“接受 GitHub Marketplace 开发者协议”的链接,然后接受协议。如果没有链接,请向组织所有者发送此“发布操作”页面的链接,并让他们接受协议。

  4. 如果元数据文件中的标签存在任何问题,您将看到错误消息。通过更新元数据文件来解决这些问题。完成后,您将看到“一切正常!”消息。

  5. 选择主要类别下拉菜单,然后点击一个类别,以帮助人们在 GitHub Marketplace 中找到您的操作。

  6. 可选,选择其他类别下拉菜单,然后点击一个辅助类别。

  7. 在标签字段中,为您的操作键入版本。这有助于人们了解此版本包含哪些更改或功能。人们将在操作专用的 GitHub Marketplace 页面中看到该版本。

  8. 在标题字段中,键入发布标题。

  9. 填写所有其他字段,然后点击发布版本。发布需要您使用双因素身份验证。有关更多信息,请参阅“配置双因素身份验证”。

从 GitHub Marketplace 中移除操作

要从 GitHub Marketplace 中移除已发布的操作,您需要更新每个已发布的版本。对发布到 GitHub Marketplace 的每个操作版本执行以下步骤。

  1. 在 GitHub 上,导航到存储库的主页。

  2. 在文件列表的右侧,点击版本

    Screenshot of the main page of a repository. A link, labeled "Releases", is highlighted with an orange outline.

  3. 在要编辑的版本旁边,点击.

    Screenshot of a release in the releases list. A pencil icon is highlighted with an orange outline.

  4. 选择将此操作发布到 GitHub Marketplace 以取消选中该框。

  5. 点击页面底部的更新版本

转移操作存储库

您可以将操作存储库转移到其他用户或组织。有关更多信息,请参阅“转移存储库”。

当存储库管理员转移操作存储库时,GitHub 会自动从以前的 URL 创建到新 URL 的重定向,这意味着使用受影响操作的工作流无需更新。

在 GitHub Marketplace 上发布的操作通过其唯一的name标识符链接到存储库,这意味着您可以从转移的存储库中发布操作的新版本,并在同一个 GitHub Marketplace 列表下发布。如果删除操作存储库,则 GitHub Marketplace 列表也会被删除,并且唯一的name标识符将可用。

注意

在组织的 GitHub 个人资料上看到的“已验证”徽章与 GitHub Marketplace 上的已验证创建者徽章不同。如果您转移操作存储库,则 GitHub Marketplace 列表将丢失已验证创建者徽章,除非新所有者也是已验证创建者。

关于 GitHub Marketplace 中的徽章

带有或已验证创建者徽章的操作表示 GitHub 已将操作的创建者验证为合作伙伴组织。合作伙伴可以发送电子邮件至[email protected] 以请求已验证创建者徽章。

Screenshot of GitHub Actions with the verified creator badge.