SonarQube GitHub Action 常见问题解决方案

SonarQube GitHub Action 常见问题解决方案

sonarqube-action Integrate SonarQube scanner to GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/so/sonarqube-action

项目基础介绍

SonarQube GitHub Action 是一个用于集成 SonarQube 扫描器的 GitHub Actions 插件。SonarQube 是一个开源平台，用于持续检查代码质量，通过静态代码分析来检测代码中的错误、漏洞和代码异味。该项目支持多种编程语言，包括但不限于 Java、Python、JavaScript、C#、C/C++ 等。

新手使用注意事项及解决方案

1. 配置文件错误

问题描述：新手在配置 github/workflows/build.yaml 文件时，可能会遇到配置错误，导致 SonarQube 扫描无法正常执行。

解决步骤：

1. 检查触发条件：确保 on 字段配置正确，通常需要配置 push 和 pull_request 事件。

   on:
     push:
       branches:
         - master
     pull_request:
       types: [opened, synchronize, reopened]
   

2. 验证 SonarQube 服务器地址和令牌：确保 host 和 login 字段正确配置，并且使用了正确的 GitHub Secrets。

   jobs:
     sonarqube:
       runs-on: ubuntu-latest
       steps:
         - name: Checking out
           uses: actions/checkout@master
           with:
             fetch-depth: 0
         - name: SonarQube Scan
           uses: kitabisa/sonarqube-action@v1.2.0
           with:
             host: $[[ secrets.SONARQUBE_HOST ]]
             login: $[[ secrets.SONARQUBE_TOKEN ]]
   

3. 检查项目基础目录和项目键：如果需要自定义项目基础目录或项目键，确保这些字段配置正确。

   uses: kitabisa/sonarqube-action@master
   with:
     host: $[[ secrets.SONARQUBE_HOST ]]
     login: $[[ secrets.SONARQUBE_TOKEN ]]
     projectBaseDir: "src/"
     projectKey: "my-custom-project"
   

2. 权限问题

问题描述：在执行 SonarQube 扫描时，可能会遇到权限不足的问题，导致扫描无法完成。

解决步骤：

1. 检查 SonarQube 用户权限：确保用于扫描的 SonarQube 用户具有“执行分析”权限。

2. 验证 GitHub Secrets：确保在 GitHub Secrets 中配置的 SonarQube 服务器地址和令牌是正确的，并且具有足够的权限。

3. 检查 GitHub Actions 权限：确保 GitHub Actions 有权访问 SonarQube 服务器，并且网络连接正常。

3. 代码覆盖率问题

问题描述：在集成代码覆盖率报告时，可能会遇到报告无法正确生成或上传的问题。

解决步骤：

1. 生成代码覆盖率报告：确保在执行 SonarQube 扫描之前，已经生成了代码覆盖率报告（如 JaCoCo、Cobertura 等）。

2. 配置代码覆盖率报告路径：在 SonarQube 扫描配置中，指定代码覆盖率报告的路径。

   uses: kitabisa/sonarqube-action@master
   with:
     host: $[[ secrets.SONARQUBE_HOST ]]
     login: $[[ secrets.SONARQUBE_TOKEN ]]
     projectBaseDir: "src/"
     projectKey: "my-custom-project"
     coverageReportPaths: "target/site/jacoco/jacoco.xml"
   

3. 验证报告格式：确保代码覆盖率报告的格式与 SonarQube 支持的格式一致，如 JaCoCo 的 XML 格式。

通过以上步骤，新手可以更好地理解和解决在使用 SonarQube GitHub Action 时可能遇到的问题。

sonarqube-action Integrate SonarQube scanner to GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/so/sonarqube-action