gtramontina/commitlint

gtramontina/commitlint 镜像说明

镜像概述

该Docker镜像封装了https://github.com/marionebl/commitlint%E5%B7%A5%E5%85%B7%EF%BC%8Ccommitlint%E6%98%AF%E4%B8%80%E6%AC%BE%E7%94%A8%E4%BA%8E%E6%A3%80%E6%9F%A5Git%E6%8F%90%E4%BA%A4%E4%BF%A1%E6%81%AF%E6%98%AF%E5%90%A6%E7%AC%A6%E5%90%88%E6%8C%87%E5%AE%9A%E8%A7%84%E8%8C%83%E7%9A%84%E5%B7%A5%E5%85%B7%EF%BC%8C%E5%B8%AE%E5%8A%A9%E5%9B%A2%E9%98%9F%E7%BB%B4%E6%8A%A4%E4%B8%80%E8%87%B4%E7%9A%84%E6%8F%90%E4%BA%A4%E8%AE%B0%E5%BD%95%E6%A0%BC%E5%BC%8F%E3%80%82

核心功能

• 检查Git提交信息是否符合预设规范
• 内置多种官方配置预设（如Angular、Conventional等）
• 支持挂载项目目录或单独的.git目录与配置文件
• 允许自定义工作目录
• 支持从标准输入（STDIN）读取提交信息

使用场景

• 开发团队内部确保提交信息格式统一
• CI/CD流水线中自动检查提交信息合规性
• 本地开发环境快速验证提交信息

配置说明

基本运行

sh
docker run --rm gtramontina/commitlint:<版本号>

挂载项目目录

镜像默认工作目录为/app，可将本地Git项目挂载到该目录：

sh
docker run --rm -v $(pwd):/app gtramontina/commitlint:<版本号>

仅挂载必要文件

若只需挂载.git目录和配置文件：

sh
docker run --rm \
  -v $(pwd)/.git:/app/.git \
  -v $(pwd)/.commitlintrc:/app/.commitlintrc \
  gtramontina/commitlint:<版本号>

自定义工作目录

如需指定其他工作目录：

sh
docker run --rm \
  -w /my-app \
  -v $(pwd):/my-app \
  gtramontina/commitlint:<版本号>

从STDIN读取提交信息

若需要从标准输入读取提交信息，需添加交互参数：

sh
docker run --rm -i gtramontina/commitlint:<版本号>

内置配置预设

镜像包含以下commitlint配置预设包，可在配置文件中直接引用：

• @commitlint/config-angular
• @commitlint/config-angular-type-enum
• @commitlint/config-conventional
• @commitlint/config-lerna-scopes
• @commitlint/config-patternplate