跳至主要内容

测试你的应用

GitHub 建议你在将应用提交到 GitHub Marketplace 之前使用 API 和 Webhooks 测试你的应用,以便你可以为客户提供理想的体验。在 onboarding 专家批准你的应用之前,它必须充分处理账单流程。

注意

本文仅适用于在 GitHub Marketplace 上发布应用。有关在 GitHub Marketplace 上发布 GitHub Actions 的更多信息,请参阅“在 GitHub Marketplace 上发布 Actions”。

测试应用

您可以使用 GitHub Marketplace 应用列表的草稿版本模拟每种账单流程。处于草稿状态的列表表示它尚未提交审核。使用 GitHub Marketplace 应用列表草稿进行的任何购买都不会创建真实的交易,GitHub 也不会向您的信用卡收费。请注意,您只能模拟在草稿列表中发布的套餐的购买,而不能模拟草稿套餐的购买。更多信息,请参见“为您的应用创建草稿列表”和“在您的应用中使用 GitHub Marketplace API”。

使用带有草稿列表的开发应用测试更改

一个 GitHub Marketplace 应用列表只能与单个应用注册关联,并且每个应用只能访问其自己的 GitHub Marketplace 应用列表。出于这些原因,我们建议您配置一个与您的生产应用具有相同配置的单独开发应用,并创建一个可用于测试的 GitHub Marketplace 应用列表草稿。GitHub Marketplace 应用列表草稿允许您测试更改,而不会影响生产应用的活跃用户。您无需提交您的开发 GitHub Marketplace 应用列表,因为您只会将其用于测试。

因为您只能为公共应用创建 GitHub Marketplace 应用列表草稿,所以您必须将您的开发应用设为公共应用。只要您不共享应用的 URL,公共应用在已发布的 GitHub Marketplace 应用列表之外是不可发现的。处于草稿状态的 Marketplace 应用列表仅对应用所有者可见。

拥有带有草稿列表的开发应用后,您就可以在与 GitHub Marketplace API 和 Webhook 集成时使用它来测试对应用所做的更改。

请不要使用已在 GitHub Marketplace 上线了的应用进行测试购买。

模拟 Marketplace 购买事件

您的测试场景可能需要设置提供免费试用版的列表套餐,并在免费和付费订阅之间切换。由于降级和取消要到下一个账单周期才会生效,GitHub 提供了一个仅限开发人员的功能“应用待定更改”来强制changedcancelled套餐操作立即生效。您可以访问带有草稿 Marketplace 应用列表的应用的https://github.com/settings/billing#pending-cycle中的**应用待定更改**。

测试 API

对于大多数 GitHub Marketplace API 端点,我们还提供存根 API 端点,这些端点返回您可以用于测试的硬编码虚假数据。要接收存根数据,您必须指定存根 URL,这些 URL 在路由中包含/stubbed(例如,/user/marketplace_purchases/stubbed)。有关支持此存根数据方法的端点列表,请参见GitHub Marketplace 端点

测试 Webhook

GitHub 提供了用于测试您已部署的有效负载的工具。更多信息,请参见“测试 Webhook”。