wunderio/circleci-sonar-scanner

circleci-sonar-scanner 镜像文档

镜像概述

circleci-sonar-scanner是一个专为CircleCI持续集成环境设计的Docker镜像，集成了Sonar Scanner工具，用于在CI流程中自动化执行代码质量和安全性分析。通过该镜像，开发者可便捷地将SonarQube代码分析集成到CircleCI流水线中，实现对项目代码的持续质量监控。

核心功能与特性

• 环境变量配置：支持通过CircleCI环境变量配置Sonar服务器认证信息（SONAR_TOKEN）和服务器地址（SONAR_HOST）
• 灵活的分析配置：支持通过sonar-scanner.properties配置文件或命令行参数自定义分析参数
• 标准Sonar Scanner支持：完全兼容SonarQube官方分析参数，可配置项目密钥、源代码路径、排除文件等

使用场景

• CircleCI流水线中的代码质量门禁检查
• 项目构建过程中的自动化代码缺陷检测
• 多语言项目的代码规范和安全性分析

使用方法

前提条件

1. 在CircleCI项目中配置以下环境变量：
   • SONAR_TOKEN：SonarQube服务器认证令牌（从SonarQube控制台获取）
   • SONAR_HOST：SonarQube服务器URL（如https://sonar.example.com）

基础配置

在.circleci/config.yml中添加分析作业：

yaml
analyze:
    docker:
      - image: wunderio/circleci-sonar-scanner
    steps:
      - checkout
      # 运行Sonar Scanner分析项目
      - run: cd /home/circleci/project/ && run-sonar-scanner

高级配置

对于需要自定义分析参数的场景，可直接使用sonar-scanner命令并指定参数（完整参数列表参见SonarQube官方文档）：

yaml
analyze:
    docker:
      - image: wunderio/circleci-sonar-scanner
    steps:
      - checkout
      - run: >-
          cd /home/circleci/project/ &&
          sonar-scanner -Dsonar.host.url=$SONAR_HOST
          -Dsonar.token=$SONAR_TOKEN
          -Dsonar.php.coverage.reportPaths=/home/circleci/project/coverage.xml
          -Dsonar.projectKey=project-name-in-sonar
          -Dsonar.sources=/home/circleci/project/src
          -Dsonar.exclusions=/home/circleci/project/tests/**

也可在项目根目录创建sonar-scanner.properties文件进行配置：

properties
sonar.host.url=https://sonar.example.com
sonar.token=your-auth-token
sonar.projectKey=project-name-in-sonar
sonar.sources=src
sonar.exclusions=tests/**

注意事项

• 确保CircleCI执行用户对项目目录有读写权限
• 代码覆盖率报告等外部文件需确保生成路径正确并可被Sonar Scanner访问
• 大型项目建议适当调整分析超时时间（通过sonar.scanner.timeout参数）