使用 docker 开发时运行预提交挂钩（例如 pylint）

Question

预提交挂钩在单独的虚拟环境（或 Docker 容器）中运行。然而，我们的代码在 Docker 上运行，我们也在使用 Docker 进行开发。

到目前为止，我们不必在主机系统上安装任何依赖项，但是在运行 mypy、isort 和 pylint 时，它们会遇到问题，因为它们无法访问已安装的依赖项。

我们的第一个想法是在主机系统的虚拟环境中安装依赖项，但是 这似乎也是一个笨拙的解决方法。

有没有一种好方法可以在完全访问容器的情况下运行预提交？

Answer 1

我们有同样的想法，这就是我们团队的最终结果：

• 预提交 Docker 映像。基于 docker 的简单、最小的 Docker 映像，仅包含 pre-commit 本身（隐式包含 python、pip 等）。 注意：这里确实需要docker 图像，因为我们确实使用了基于 Docker 的钩子。
• 包含“复杂”钩子/检查器的独立 Docker 映像集。 “复杂”是指那些需要一些构建时依赖项、编译器、额外库等的东西，这些东西不能用简单的“pip install”安装在干净的机器上。一个例子是clang-format，我们从源代码构建，所以最终的clang-format Docker 镜像只包含clang-format 二进制文件。这就是mypy 可能会去的地方，因为它有很多额外的非 Python 依赖项。

注意：在“docker in docker”模式下工作时，pre-commit 有点糟糕，所以我们必须应用一个解决方法，请参阅https://github.com/pre-commit/pre-commit/issues/1387

最后，我们的.pre-commit-config.yaml 文件包含如下条目：

# Normal, "simple" hooks which can be just installed as is
- repo: ...pre-commit-hooks/pre-commit-hooks
  rev: v3.3.0
  hooks:
   - ...

# Docker hooks
- repo: local
  hooks:
  - id: docker-clang-format
    name: Docker Clang Format
    language: docker_image
    types:
    - c++
    entry: <our-registry.com>/clang_format:11

# Local workarounds for devs who cannot or don't want to use Docker, but still would like to benefit from running pre-commit locally
- repo: <...>/pre-commit-clang-format
    rev: ...
    hooks:
      - id: clang-format
        stages: [manual]  # Mind this line, only for manual run
        types:
          - c++

Answer 2

为代码样式检查创建一个特殊的容器怎么样？

它应该安装了所有需要的 linter 和一个 bash 文件来检查代码目录。

你的钩子命令看起来像docker run -v [mount code dir to container in RO mode] codestyle_check_container