PRs 上的 CI 测试工作流程

本指南帮助贡献者理解 PR (Pull Request) 上的持续集成 (CI) 工作流程。CI 指的是在 PR 代码库上进行的自动化测试。

microcheck：PR 上的默认测试

默认情况下，在您的 PR 的每次提交时，我们将运行一组名为 microcheck 的测试。

这些测试旨在以 90% 的准确率捕获 PR 中的 bug，同时只运行完整测试套件的 10%。因此，microcheck 通常比完整测试套件快两倍，成本低两倍。microcheck 的一些显著特性包括：

• 如果在 pull request 中添加了新测试或修改了现有测试，microcheck 会确保包含这些测试。

• 您可以通过在 git commit 消息正文中包含以下行来手动向 microcheck 添加更多测试：@microcheck TEST_TARGET01 TEST_TARGET02 ....。此行必须位于消息正文中，从第二行或以下开始（第一行是提交消息标题）。例如，这是我在 pull request 中手动添加测试的方式：

  // git command to add commit message
  git commit -a -s
  
  // content of the commit message
  run other serve doc tests
  
  @microcheck //doc:source/serve/doc_code/distilbert //doc:source/serve/doc_code/object_detection //doc:source/serve/doc_code/stable_diffusion
  
  Signed-off-by: can <can@anyscale.com>
  

如果 microcheck 通过，您将在 PR 上看到一个绿色对勾。如果失败，您将看到一个红色叉。无论哪种情况，您都可以在 GitHub UI 中看到测试运行状态摘要。

合并时的附加测试

在此工作流程中，要合并您的 PR，只需单击“启用自动合并”按钮（或请求提交者执行此操作）。这将触发附加测试用例，并且一旦它们完成并通过，PR 将自动合并。

或者，您也可以添加一个 go 标签来手动触发 PR 上的完整测试套件（请注意，这不太推荐，但我们理解您最了解您的 PR 的需求）。虽然我们预计这种情况很少需要，但如果您经常需要，请告知我们。我们正在不断改进 microcheck 的有效性。