pre-commit Docker镜像

镜像概述和主要用途

pre-commit Docker镜像是一个基于Python的容器化解决方案，集成了pre-commit工具，旨在提供便捷的代码检查能力。该镜像适用于本地开发环境、CI/CD流水线等场景，帮助开发者自动化执行代码检查钩子，确保代码质量。

核心功能和特性

• 轻量级基础：基于debian-slim构建，减少镜像体积
• 多架构支持：兼容amd64和arm64架构
• 自动更新机制：通过比较软件物料清单(SBOM)变更实现自动更新
• 安全保障：使用Cosign进行镜像签名
• 透明化构建：通过Syft生成并附加SBOM证明
• 多平台可用：同时发布于Docker Hub和Quay.io容器仓库

![GitLab]([] 主仓库
![Docker Hub]([] Docker Hub仓库
![Quay.io]([***] Quay.io仓库

使用场景和适用范围

• 本地开发环境中的代码提交前检查
• CI/CD流水线中的自动化代码质量检测
• 多架构开发环境的统一代码检查标准
• 需要严格供应链安全保障的开发流程

使用方法和配置说明

本地环境运行pre-commit

shell
docker run -t --rm -v $(pwd):/workdir jfxs/pre-commit /bin/bash -c "pre-commit run --all-files"

首次运行时，pre-commit会自动下载、安装必要的钩子（pre-commit autoupdate）并保存在.cache/pre-commit目录。请确保将.cache目录添加到.gitignore文件中。

使用task工具运行

shell
docker run -t --rm -v $(pwd):/workdir {{.TAG}} /bin/bash -c "task --taskfile /lint.yml pre-commit DIR=/workdir"

若本地已安装task工具并使用lint 任务模板，可直接执行：

shell
task lint:pre-commit

若.pre-commit-config.yaml文件不存在，将自动创建以下默认配置：

yaml
---
repos:
  - repo: [***]
    rev: v4.5.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-added-large-files
      # 从示例配置添加的钩子
      - id: check-executables-have-shebangs
      - id: check-json
      - id: check-merge-conflict
      - id: check-shebang-scripts-are-executable
      - id: check-symlinks
      - id: check-toml
      - id: check-xml
      - id: detect-private-key
      - id: end-of-file-fixer
      - id: fix-byte-order-marker
      - id: mixed-line-ending
      - id: trailing-whitespace
        args: [--markdown-linebreak-ext=md]

在Gitlab-CI中运行

Gitlab-CI配置示例：

yaml
...
gitlab-release:
  image: jfxs/pre-commit
  stage: lint
  script:
    - task --taskfile /lint.yml pre-commit DIR=$(pwd)

构建信息

Docker最新标签为4.3.0-010, 4.3, 4，包含以下组件：

最新镜像详细信息可查看Dockerhub概览页。

版本控制

Docker镜像标签格式定义为：

text
<pre-commit_version>-<increment>

• <pre-commit_version>: 使用的pre-commit版本
• <increment>: 同版本构建的递增编号，从001开始

示例：3.6.1-001

签名与证明

Cosign公钥：

shell
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEa3yV6+yd/l4zh/tfT6Tx+zn0dhy3
BhFqSad1norLeKSCN2MILv4fZ9GA6ODOlJOw+7vzUvzZVr9IXnxEdjoWJw==
-----END PUBLIC KEY-----

公钥在线地址：<[***]>

验证镜像

shell
cosign verify --key cosign.pub $IMAGE_URI

验证并获取SBOM证明

shell
cosign verify-attestation --key cosign.pub --type spdxjson $IMAGE_URI | jq '.payload | @base64d | fromjson | .predicate'

许可证

本程序是自由软件：您可以根据MIT许可证（MIT）的条款重新分发和/或修改它。详情参见LICENSE。