geekupvn/gitlab-sonar-scanner

geekupvn/gitlab-sonar-scanner 镜像说明

镜像概述

本Docker镜像提供GitLab CI环境下的Sonar Scanner工具，可与Sonar GitLab插件无缝集成，帮助开发者在持续集成流程中自动执行代码质量分析，并将结果反馈至GitLab项目（如合并请求或提交记录），提升代码质量管控效率。

核心功能

• 双模式分析：支持issues模式（在GitLab中展示代码问题）和publish模式（向SonarQube服务器发布完整分析报告）
• 灵活配置：通过环境变量定义SonarQube地址、项目版本、源代码路径等核心参数
• 自定义扩展：允许传递额外的Sonar Scanner参数，满足个性化分析需求
• CI集成：与GitLab CI流水线深度整合，无需额外安装依赖即可快速部署

使用场景

• GitLab项目持续集成流程中，添加代码质量检测阶段
• 对项目代码进行静态分析，识别bugs、漏洞、代码异味等问题
• 将SonarQube分析结果直接同步至GitLab，方便团队协作与代码评审

配置说明

1. 准备sonar-project.properties文件

在项目根目录创建配置文件，指定项目标识、排除目录等：

conf
sonar.projectKey=你的项目唯一标识
sonar.exclusions=node_modules/**,coverage/**  # 排除无需分析的目录
sonar.sources=.  # 源代码根路径
sonar.gitlab.project_id=git@你的Git仓库地址.git  # GitLab项目地址（支持SSH/HTTP URL等格式）

2. 在GitLab CI中配置分析阶段

示例1：Issues模式（展示代码问题）

yaml
stages:
- analysis

sonarqube:
  stage: analysis
  image: geekupvn/gitlab-sonar-scanner
  variables:
    SONAR_URL: [***]
    SONAR_ANALYSIS_MODE: issues
  script:
  - gitlab-sonar-scanner

示例2：Publish模式（发布报告至SonarQube）

yaml
sonarqube-reports:
  stage: analysis
  image: geekupvn/gitlab-sonar-scanner
  variables:
    SONAR_URL: [***]
    SONAR_ANALYSIS_MODE: publish
  script:
  - gitlab-sonar-scanner

示例3：同时启用双模式

yaml
stages:
- analysis

sonarqube:
  stage: analysis
  image: geekupvn/gitlab-sonar-scanner
  variables:
    SONAR_URL: [***]
    SONAR_ANALYSIS_MODE: issues
  script:
  - gitlab-sonar-scanner

sonarqube-reports:
  stage: analysis
  image: geekupvn/gitlab-sonar-scanner
  variables:
    SONAR_URL: [***]
    SONAR_ANALYSIS_MODE: publish
  script:
  - gitlab-sonar-scanner

3. 环境变量说明

核心变量：

• SONAR_URL：SonarQube服务器地址
• SONAR_PROJECT_VERSION：项目版本号
• SONAR_DEBUG：开启调试模式（可选，值为true）
• SONAR_SOURCES：源代码路径（覆盖sonar-project.properties中的配置）
• SONAR_GITLAB_PROJECT_ID：GitLab项目标识（支持多种格式）
• CI_BUILD_REF/CI_BUILD_REF_NAME：GitLab CI内置变量（提交哈希/分支名称）

4. 传递自定义参数

若需添加Sonar Scanner未覆盖的参数，可直接在脚本中追加：

yaml
sonarqube-reports:
  image: geekupvn/gitlab-sonar-scanner
  variables:
    SONAR_URL: [***]
    SONAR_ANALYSIS_MODE: publish
  script:
  - gitlab-sonar-scanner -Dsonar.custom.param=自定义值 -Dsonar.another.param=另一值

许可证

本镜像代码基于GNU-GPLv3许可证授权，版权归Alvarium.io 2017-2018所有。详情请查看https://github.com/ciricihq/gitlab-sonar-scanner/blob/master/LICENSE%E3%80%82 ===END===