johanvanhelden/gha-clover-test-coverage-check

gha-clover-test-coverage-check

概述

gha-clover-test-coverage-check是一个用于GitHub Actions的Clover测试覆盖率检查器，主要用途是验证项目的测试覆盖率是否达到预设的最低要求，帮助开发者在CI/CD流程中确保代码质量。

核心功能和特性

• 支持设置最低覆盖率百分比阈值
• 可指定Clover格式的覆盖率XML文件路径
• 提供覆盖率值的四舍五入精度配置
• 可控制在覆盖率不达标时是否退出流程
• 支持选择不同的覆盖率指标进行检查
• 输出多种覆盖率相关参数，便于后续步骤使用

使用场景和适用范围

适用于GitHub Actions工作流中需要对代码测试覆盖率进行检查的场景，尤其适合在CI/CD流程中作为质量门禁，确保代码提交或合并前测试覆盖率达到团队设定的标准。

使用方法

基本用法

在工作流中添加以下步骤即可使用：

yml
- name: Check test coverage
  id: test-coverage
  uses: johanvanhelden/gha-clover-test-coverage-check@v1
  with:
    percentage: "95"
    filename: "coverage.xml"

输入参数（Input）

percentage

必填，允许的最低覆盖率百分比。

filename

必填，Clover覆盖率XML文件的文件名。

rounded-precision（可选）

四舍五入后覆盖率值的精度。0表示向上取整（例如：99.999999会四舍五入为100）。默认值：2。

exit（可选）

当覆盖率未达到要求时是否退出流程。默认值：true。

metric（可选）

要获取和处理的覆盖率指标。默认值：elements。

输出参数（Output）

输出参数通过https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context%E5%AF%BC%E5%87%BA%EF%BC%8C%E5%8F%AF%E5%9C%A8%E5%90%8E%E7%BB%AD%E6%AD%A5%E9%AA%A4%E4%B8%AD%E4%BD%BF%E7%94%A8%E3%80%82

使用示例

yml
- name: Test coverage
  run: echo "${{ steps.test-coverage.outputs.coverage }}"

或设置条件步骤：

yml
- name: Test coverage report
  if: steps.test-coverage.outputs.coverage > 50
  run: echo "我们已完成一半以上的覆盖率目标！"

输出参数说明

• coverage: 计算得到的覆盖率原始值
• coverage-display: 用于展示的覆盖率值
• coverage-rounded: 四舍五入后的覆盖率值
• coverage-rounded-display: 用于展示的四舍五入后覆盖率值
• coverage-acceptable: 检查结果的布尔值（true/false），可结合exit参数实现自定义覆盖率逻辑

生成覆盖率报告

以下是使用PHPUnit生成Clover格式覆盖率报告的示例：

yml
- name: Generate code coverage
  run: ./vendor/bin/phpunit --coverage-clover ./coverage.xml

动作开发（Action Development）

可通过以下命令在本地测试该动作：

bash
docker-compose up --build

所有参数可在docker-compose.yml文件中配置。

构建和发布（Building and publishing）

当标记新版本时，构建过程会自动触发。

若需手动构建，请确保已通过docker login登录hub.docker.com并有权限访问仓库（注意：使用用户名登录，而非***）。

bash
$ docker build ./ --tag johanvanhelden/gha-clover-test-coverage-check:TAG
$ docker push johanvanhelden/gha-clover-test-coverage-check:TAG

将TAG替换为您正在使用的版本标签。