pre-commit

![pre-commit.ci 状态]([] ![Docker 拉取次数]([] ![GitHub 容器注册表]([] ![GitHub 许可证]([]

用于运行pre-commit钩子的预构建镜像集合。可在Docker Hub和GitHub 容器注册表获取。

镜像概述和主要用途

pre-commit镜像集合提供预构建环境，用于运行pre-commit钩子。pre-commit是一款自动化工具，可在代码提交前执行代码格式化、语法检查、安全扫描等一系列检查，帮助团队维护代码质量和一致性。本镜像无需手动安装pre-commit及其依赖，可直接集成到开发流程或CI/CD管道中。

核心功能和特性

• 多版本支持：提供Python 3.8至3.12多个版本镜像，满足不同项目的依赖需求。
• 精简版本：每个Python版本均提供slim标签的精简镜像，体积更小，适合资源受限环境。
• 即开即用：预安装pre-commit及相关依赖，无需额外配置即可运行钩子。
• 跨平台可用：同时发布到Docker Hub和GitHub容器注册表，方便不同环境获取。

使用场景和适用范围

• 本地开发：开发人员在本地提交代码前通过Docker快速运行pre-commit钩子，确保提交代码符合团队规范。
• CI/CD集成：在持续集成流程中自动运行pre-commit检查，拒绝不符合规范的代码提交。
• 团队协作：统一团队的pre-commit运行环境，避免因本地环境差异导致钩子执行结果不一致。
• 临时环境：在无需长期安装pre-commit的环境中（如临时开发环境、测试环境）快速执行代码检查。

可用镜像

使用方法和配置说明

基本使用（本地开发）

1. 准备项目：确保项目根目录包含.pre-commit-config.yaml文件（pre-commit配置文件）。

2. 运行pre-commit钩子： 使用以下命令在当前项目中运行pre-commit钩子：

   bash
   docker run --rm -v $(pwd):/app -w /app johannlange/pre-commit:latest pre-commit run
   

   • --rm：容器退出后自动删除。
   • -v $(pwd):/app：将当前目录挂载到容器内的/app目录。
   • -w /app：设置工作目录为/app，确保pre-commit在项目根目录运行。
   • pre-commit run：执行pre-commit钩子检查。

3. 运行特定钩子或文件： 可指定钩子ID或文件路径：

   bash
   # 运行特定钩子
   docker run --rm -v $(pwd):/app -w /app johannlange/pre-commit:latest pre-commit run <hook-id>
   
   # 检查特定文件
   docker run --rm -v $(pwd):/app -w /app johannlange/pre-commit:latest pre-commit run --files <file-path>
   

CI/CD集成示例（GitHub Actions）

在.github/workflows/pre-commit.yml中添加以下配置：

yaml
name: pre-commit
on: [pull_request, push]

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run pre-commit
        run: |
          docker run --rm -v $(pwd):/app -w /app johannlange/pre-commit:latest pre-commit run --all-files

选择特定Python版本

根据项目Python版本选择对应镜像标签，例如使用Python 3.12的精简版：

bash
docker run --rm -v $(pwd):/app -w /app johannlange/pre-commit:3.12-slim pre-commit run