voxpupuli/commitlint

Vox Pupuli Commitlint容器

镜像概述和主要用途

该容器用于校验提交信息，封装了https://github.com/conventional-changelog/commitlint%E5%8F%8A%E5%85%B6%E6%89%80%E6%9C%89%E5%BF%85%E8%A6%81%E6%8F%92%E4%BB%B6%E3%80%82%E8%AF%A6%E6%83%85%E5%8F%82%E8%A7%81package.json%E3%80%82%E8%BF%99%E6%98%AF%E4%B8%80%E4%B8%AA%E8%BF%90%E8%A1%8C%E5%9C%A8Alpine%E5%AE%B9%E5%99%A8%E4%B8%AD%E7%9A%84npm%E5%BA%94%E7%94%A8%E3%80%82

核心功能和特性

• 封装commitlint及所有必要插件，无需额外安装依赖
• 基于Alpine镜像，体积轻量，运行高效
• 支持多种提交校验方式：校验最后一次提交、校验分支所有提交等
• 可通过配置文件自定义校验规则
• 易于集成到CI/CD流程中

使用场景和适用范围

• 团队协作中确保提交信息符合规范
• Git仓库提交信息自动化校验
• CI/CD流水线中集成（如GitLab CI、GitHub Actions等）
• 规范化版本控制和变更日志生成

使用方法和配置说明

校验最后一次提交

shell
podman run -it --rm -v $PWD:/data ghcr.io/voxpupuli/commitlint:latest
# 或（默认行为）
podman run -it --rm -v $PWD:/data ghcr.io/voxpupuli/commitlint:latest --last

（注：也可使用docker命令替代podman）

校验分支的所有提交

shell
podman run -it --rm -v $PWD:/data ghcr.io/voxpupuli/commitlint:latest \
  --from $(git merge-base $(git symbolic-ref refs/remotes/origin/HEAD --short) HEAD) \
  --to HEAD

更多选项

查看更多选项：

shell
podman run -it --rm -v $PWD:/data ghcr.io/voxpupuli/commitlint:latest --help

示例commitlint配置

参见.commitlint.yaml

yaml
---
# 以下规则手动复制自@commitlint/config-conventional
# 符合v1.0.0规范：
# https://www.conventionalcommits.org/en/v1.0.0/#specification
#
# 当以下问题修复后，可移除这些规则并取消注释下方配置：https://github.com/conventional-changelog/commitlint/issues/613
#
# extends:
#   - '@commitlint/config-conventional'
rules:
  body-leading-blank: [1, always]
  footer-leading-blank: [1, always]
  footer-max-line-length: [2, always, 100]
  header-max-length: [2, always, 100]
  subject-case:
    - 2
    - never
    - [sentence-case, start-case, pascal-case, upper-case]
  subject-empty: [2, never]
  subject-full-stop: [2, never, "."]
  type-case: [2, always, lower-case]
  type-empty: [2, never]
  type-enum:
    - 2
    - always
    - [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test]

示例GitLab CI任务

yaml
commitlint:
  stage: .pre # GitLab CI的默认阶段，在其他所有流水线之前运行
  image:
    name: ghcr.io/voxpupuli/commitlint:latest
    entrypoint: [""] # 覆盖入口点
  interruptible: true
  variables:
    # 检出整个仓库并使用克隆
    GIT_DEPTH: 0
    GIT_STRATEGY: clone
  script:
    # 切换到MR分支而非分离HEAD
    - git switch $CI_COMMIT_REF_NAME
    - commitlint --from $(git merge-base origin/$CI_DEFAULT_BRANCH HEAD) --to HEAD
  rules:
    # 仅在合并请求流水线中运行
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'