christophebedard/dco-check

dco-check

https://img.shields.io/pypi/v/dco-check](https://pypi.org/project/dco-check/) https://codecov.io/gh/christophebedard/dco-check/branch/master/graph/badge.svg](https://codecov.io/gh/christophebedard/dco-check) https://img.shields.io/github/license/christophebedard/dco-check](https://github.com/christophebedard/dco-check/blob/master/LICENSE) https://img.shields.io/docker/pulls/christophebedard/dco-check?logo=docker](https://hub.docker.com/r/christophebedard/dco-check)

https://img.shields.io/github/workflow/status/christophebedard/dco-check/CI?label=CI&logo=github](https://github.com/christophebedard/dco-check) https://img.shields.io/gitlab/pipeline/christophebedard/dco-check?label=CI&logo=gitlab](https://gitlab.com/christophebedard/dco-check/commits/master) https://img.shields.io/travis/com/christophebedard/dco-check?label=CI&logo=travis](https://travis-ci.com/github/christophebedard/dco-check) https://img.shields.io/azure-devops/build/christophebedard/74e64a5d-0fe6-4759-bb97-eb77bb0d15af/1?label=CI&logo=azure%20pipelines](https://dev.azure.com/christophebedard/dco-check/_build/latest?definitionId=1&branchName=master) https://img.shields.io/appveyor/build/christophebedard/dco-check?label=CI&logo=appveyor](https://ci.appveyor.com/project/christophebedard/dco-check) https://img.shields.io/circleci/build/github/christophebedard/dco-check?label=CI&logo=circle&logoColor=white](https://circleci.com/gh/christophebedard/dco-check)

镜像概述和主要用途

dco-check是一个简单的DCO检查脚本，用于在任何CI平台中验证提交是否包含符合开发者证书来源(DCO)要求的"Signed-off-by:"行。它确保所有提交都经过贡献者签名认证，适用于需要DCO合规性检查的开源项目。

核心功能和特性

• 多CI平台支持：兼容GitHub、GitLab、Azure Pipelines、AppVeyor、CircleCI、Travis CI等主流CI平台
• 灵活的使用方式：支持通过PyPI安装、Docker镜像运行或直接下载脚本执行
• 智能提交检测：自动识别特性分支提交和默认分支新提交，适应不同开发流程
• 配置选项丰富：支持忽略合并提交、指定默认分支、设置远程仓库、静默/详细模式等
• 环境变量支持：可通过环境变量配置检查参数，命令行参数优先级高于环境变量

使用场景和适用范围

• 开源项目的CI流程中，自动检查拉取/合并请求的提交是否符合DCO要求
• 监控默认分支（如master）的新提交，确保所有代码贡献均经过DCO签名
• 在本地开发环境中，提交前手动验证DCO合规性

详细使用方法和配置说明

获取和使用方式

1. 使用Docker镜像

shell
$ docker run --rm -v $(pwd):/repo -w /repo christophebedard/dco-check:latest dco-check

2. 通过PyPI安装

shell
$ pip install dco-check
$ dco-check

3. 直接下载脚本

shell
$ wget https://raw.githubusercontent.com/christophebedard/dco-check/master/dco_check/dco_check.py
$ python3 dco_check.py

退出码说明

• 0：所有检查的提交均包含有效的DCO签名
• 非0：存在未签名的提交或检查过程出错

命令行选项

运行dco-check --help查看完整选项，主要包括：

• --ignore-merge-commits：忽略合并提交
• --default-branch：指定默认分支（默认为"master"）
• --remote：指定远程仓库（默认为"origin"）
• --quiet：静默模式，仅输出错误信息
• --verbose：详细模式，输出详细检查过程

环境变量配置

支持通过环境变量设置参数（命令行参数优先级更高），具体变量可通过--help查看。

CI支持情况

示例CI配置

GitHub Actions

yaml
# .github/workflows/dco.yml
name: DCO
on:
  pull_request:
  push:
    branches:
      - master
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python 3.x
      uses: actions/setup-python@v1
      with:
        python-version: '3.x'
    - name: Check DCO
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        pip3 install -U dco-check
        dco-check

GitLab CI/CD

yaml
# .gitlab-ci.yml
variables:
  DOCKER_DRIVER: overlay2
dco:
  image: christophebedard/dco-check:latest
  rules:
    - if: $CI_MERGE_REQUEST_ID
    - if: $CI_EXTERNAL_PULL_REQUEST_IID
    - if: $CI_COMMIT_BRANCH == 'master'
  script:
    - pip3 install -U dco-check  # 可选
    - dco-check

Python版本支持

需要Python 3.6及以上版本（因使用f-strings语法）。如有需要支持旧版本Python 3，可通过修改代码移除f-strings实现。

贡献指南

参见CONTRIBUTING.md。