GitHub Actions中Spring Boot项目JaCoCo配置与覆盖率问题解决
报错根因
当前触发FileNotFoundError的核心原因有两个:
- 你使用的JaCoCo徽章生成Action在未显式指定CSV文件路径时,默认查找Maven项目的固定报告路径
target/site/jacoco/jacoco.csv,但你是Gradle项目,CSV报告实际输出在build/reports/jacoco/jacoco.csv,路径完全不匹配。 - 原工作流仅执行
./gradlew build,增量构建场景下可能跳过jacocoTestReport任务,进一步导致目标CSV文件不存在。
完整实现方案(匹配两项业务需求)
第一步:修正Gradle配置,保证报告数值和自定义校验规则一致
你现有的Gradle配置存在偏差:jacocoTestCoverageVerification中定义了排除类清单,但生成CSV报告的jacocoTestReport任务没有同步配置同样的排除规则,会导致最终CSV统计的覆盖率数值包含被排除的类,和你的自定义校验规则计算值不一致。
需要在jacocoTestReport任务中补充相同的排除配置,修正后的完整Jacoco配置如下:
test { finalizedBy jacocoTestReport // 测试执行完成后自动生成报告 } jacoco { toolVersion = "0.8.6" } jacocoTestReport { dependsOn test sourceSets sourceSets.main executionData fileTree(project.rootDir.absolutePath).include("**/build/jacoco/*.exec") // 同步覆盖率校验的排除规则,保证CSV统计值和自定义规则一致 excludes = [ 'com.cicd.herokuautodeploy.model.*', 'com.cicd.herokuautodeploy.HerokuautodeployApplication', 'com.cicd.herokuautodeploy.it.*' ] reports { xml.enabled false csv.enabled true html.destination file("${buildDir}/reports/jacoco/Html") csv.destination file("${buildDir}/reports/jacoco/jacoco.csv") } } // 保留原有自定义覆盖率校验规则 jacocoTestCoverageVerification { violationRules { rule { element = 'CLASS' limit { counter = 'LINE' value = 'COVEREDRATIO' minimum = 1.0 } excludes = [ 'com.cicd.herokuautodeploy.model.*', 'com.cicd.herokuautodeploy.HerokuautodeployApplication', 'com.cicd.herokuautodeploy.it.*' ] } } }
第二步:修正GitHub Actions工作流,解决路径报错+实现报告分支存储
核心调整点:
- 拉取代码时绑定本次PR触发的源分支提交,避免后续报告提交到错误分支
- 显式执行Jacoco报告生成和覆盖率校验任务,避免增量构建跳过流程
- 给徽章生成Action传入实际的CSV文件路径,解决找不到文件的报错
- 将HTML报告持久化提交回对应分支,而非仅上传90天有效期的临时构建工件
- 保留原有的临时工件上传能力,作为快速排查的备份
修正后的完整工作流配置:
name: Build WorkFlow - Building and Validating Test Coverage on: pull_request: branches: [ main,dev ] jobs: build: runs-on: ubuntu-latest permissions: contents: write # 允许工作流向分支推送提交 steps: # 拉取本次PR对应的源分支代码,避免提交错分支 - uses: actions/checkout@v2 with: ref: ${{ github.event.pull_request.head.sha }} fetch-depth: 0 - name: Set up JDK 1.11 uses: actions/setup-java@v1 with: java-version: 1.11 - name: Grant execute permission for gradlew run: chmod +x gradlew # 显式执行报告生成+覆盖率校验,避免增量构建跳过流程 - name: Build with Gradle run: ./gradlew clean build jacocoTestReport jacocoTestCoverageVerification # 修正徽章生成的CSV路径,解决FileNotFoundError - name: Generate JaCoCo Badge id: jacoco uses: cicirello/jacoco-badge-generator@v2.0.1 with: jacoco-csv-file: build/reports/jacoco/jacoco.csv badges-directory: .github/badges # 徽章文件存储路径 - name: Log coverage percentage run: | echo "coverage = ${{ steps.jacoco.outputs.coverage }}" echo "branch coverage = ${{ steps.jacoco.outputs.branches }}" # 提交徽章+HTML报告到对应分支 - name: Commit badge and coverage report run: | # 创建报告存储目录 mkdir -p coverage-reports/${{ github.head_ref }} # 把生成的HTML报告复制到分支持久化目录 cp -r build/reports/jacoco/Html/* coverage-reports/${{ github.head_ref }}/ # 检查是否有文件变更 if [[ `git status --porcelain` ]]; then git config --global user.name 'github-actions[bot]' git config --global user.email 'github-actions[bot]@users.noreply.github.com' git add -A git commit -m "Update coverage report and badge for ${{ github.head_ref }}" git push fi # 保留临时工件上传能力 - name: Upload JaCoCo coverage report uses: actions/upload-artifact@v2 with: name: jacoco-report path: build/reports/jacoco/
补充配置注意事项
- 仓库需要开启工作流的写入权限:进入仓库设置 -> Actions -> 通用配置,将工作流权限调整为“读写权限”,否则向分支推送报告和徽章时会触发权限不足报错。
- 生成的HTML报告通过
coverage-reports/<分支名>/路径持久化在分支中,可直接通过GitHub文件浏览器访问查看报告内容;覆盖率徽章存储在.github/badges/目录,可直接在README中引用展示。 - 由于Gradle配置中已同步排除规则,徽章展示的覆盖率数值和你的自定义覆盖率校验规则计算的数值完全一致,不会出现数值偏差。
内容的提问来源于stack exchange,提问作者springbootlearner
相关产品推荐
相关产品推荐

