运行 Lint 分析和单元测试

  • 6 分钟

GitHub Actions 可用于自动执行事件触发的任务。 若要在创建拉取请求时触发代码质量检查，你需要：

  • 使用 Linter 和单元测试验证代码。
  • 将代码检查与拉取请求相集成。

验证代码

需要对代码执行两种常见类型的检查：Linter 和单元测试。

可以使用 Linter 检查代码是否符合组织设置的质量准则。 例如，若要使用 Flake8 对代码进行 Lint 分析，需要创建一个 .flake8 配置文件，其中包含代码必须遵循的规则。

若要检查代码是否按预期工作，可以创建单元测试。 若要轻松测试代码的特定部分，脚本应包含函数。 可以通过创建测试文件来测试脚本中的函数。 用于测试 Python 代码的常用工具是 Pytest。

提示

详细了解如何使用 Pytest 运行单元测试。

若要使用 GitHub Actions 检查代码，你需要：

  • 安装工具（Flake8 或 Pytest）。
  • 通过指定需要检查的存储库中的文件夹来运行测试。

提示

可以使用 GitHub Actions 自动验证代码，也可以在 Visual Studio Code 中进行手动验证。 详细了解如何在本地验证代码。

将代码检查与拉取请求相集成。

若要在创建拉取请求时触发 GitHub Actions 工作流，可以使用 on: pull_request。

需要确保仅当所有质量检查都通过时才能合并拉取请求。

若要将代码检查与针对主分支的任何拉取请求集成，需要执行以下操作：

  1. 导航到存储库中的“设置”选项卡。
  2. 选择“分支”。
  3. 在主分支的分支保护规则中启用“合并前需要通过状态检查”。

设置在合并前需要状态检查的屏幕截图。

在这里，可以搜索并选择 Linter 和单元测试，根据需要对它们进行设置。 随后，每当创建拉取请求时，你会注意到，它将触发 GitHub Actions，并且仅当工作流成功通过时，你才能合并此拉取请求。

注意

若要配置在合并拉取请求前所需的代码检查，需要在 GitHub Actions 工作流中为你的作业命名。 然后，可以通过搜索作业名称来查找检查。