Skip to main content

在 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.yml),你会看到一个横幅,提示将该操作发布到 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. 在文件列表右侧,单击“发布”。

    存储库的主页的屏幕截图。 标记为“版本”的链接以橙色边框突出显示。

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

    版本列表中的版本屏幕截图。 铅笔图标以橙色轮廓突出显示。

  4. 选择“ 将此操作发布到 GitHub Marketplace ”以从框中删除该复选框。

  5. 单击页面底部的“更新版本”。

转移操作存储库

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

当存储库管理员将操作存储库传输到新 URL 时, GitHub 会自动创建从上一 URL 重定向到新 URL,这意味着不需要更新使用受影响操作的工作流。

已发布到 GitHub Marketplace 的操作会通过其唯一的 name 标识符关联到某个仓库,这意味着你可以在同一 GitHub Marketplace 条目下,从转移后的仓库发布该操作的新版本。 如果删除某个操作存储库,GitHub Marketplace 列表也会被删除,并且唯一的 name 标识符将可供再次使用。

注意

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

关于角标 GitHub Marketplace

带有 (即“已验证创作者”徽章)的操作表明,GitHub 已认证该操作的创建者属于合作伙伴组织。 合作伙伴可以通过向 partnerships@github.com 发送电子邮件来请求已验证的创建者徽章。

GitHub Actions 的屏幕截图,其中显示已验证的创建者徽章。