buildo/sonarqube

sonarqube-with-branch-plugin 镜像文档

概述

sonarqube-with-branch-plugin是一个预集成了https://github.com/mc1arke/sonarqube-community-branch-plugin%E7%9A%84SonarQube%E9%95%9C%E5%83%8F%E3%80%82SonarQube%E6%98%AF%E4%B8%80%E6%AC%BE%E5%BC%80%E6%BA%90%E7%9A%84%E4%BB%A3%E7%A0%81%E8%B4%A8%E9%87%8F%E5%92%8C%E5%AE%89%E5%85%A8%E6%80%A7%E5%88%86%E6%9E%90%E5%B9%B3%E5%8F%B0%EF%BC%8C%E8%80%8Ccommunity-branch-plugin%E4%B8%BASonarQube%E7%A4%BE%E5%8C%BA%E7%89%88%E6%8F%90%E4%BE%9B%E4%BA%86%E5%88%86%E6%94%AF%E5%88%86%E6%9E%90%E5%92%8CPull Request分析能力，弥补了社区版在多分支支持上的功能缺口。

核心功能与特性

• 基础功能：继承SonarQube的全部核心功能，包括代码质量检测、安全漏洞扫描、代码覆盖率分析等
• 分支分析：通过community-branch-plugin支持多分支代码质量分析，可对不同分支进行独立评估
• Pull Request分析：支持对Pull Request进行针对性分析，提供代码变更的质量反馈
• 无缝集成：插件已预先配置，无需手动安装，开箱即可使用分支分析功能

使用场景

• 开发团队使用SonarQube社区版进行代码质量管控，需要对多分支进行分析
• 持续集成/持续部署(CI/CD)流程中，需对Pull Request或特性分支进行自动化代码质量检查
• 希望在不升级至SonarQube商业版的情况下获得分支分析能力的中小型项目

使用方法与配置说明

基本运行命令

bash
docker run -d \
  --name sonarqube-with-branch \
  -p 9000:9000 \
  -e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true \
  sonarqube-with-branch-plugin

Docker Compose配置示例

yaml
version: '3'
services:
  sonarqube:
    image: sonarqube-with-branch-plugin
    container_name: sonarqube-with-branch
    ports:
      - "9000:9000"
    environment:
      - SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true
      - SONARQUBE_JDBC_URL=jdbc:postgresql://db:5432/sonar
      - SONARQUBE_JDBC_USERNAME=sonar
      - SONARQUBE_JDBC_PASSWORD=sonar
    volumes:
      - sonarqube_data:/opt/sonarqube/data
      - sonarqube_extensions:/opt/sonarqube/extensions
      - sonarqube_logs:/opt/sonarqube/logs
    depends_on:
      - db
  db:
    image: postgres:13
    environment:
      - POSTGRES_USER=sonar
      - POSTGRES_PASSWORD=sonar
      - POSTGRES_DB=sonar
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  sonarqube_data:
  sonarqube_extensions:
  sonarqube_logs:
  postgres_data:

关键配置参数

分支分析使用方式

在执行SonarQube扫描时，通过以下参数指定分支：

bash
sonar-scanner \
  -Dsonar.projectKey=my-project \
  -Dsonar.sources=. \
  -Dsonar.host.url=http://localhost:9000 \
  -Dsonar.login=admin-token \
  -Dsonar.branch.name=feature/new-feature

对于Pull Request分析：

bash
sonar-scanner \
  -Dsonar.projectKey=my-project \
  -Dsonar.sources=. \
  -Dsonar.host.url=http://localhost:9000 \
  -Dsonar.login=admin-token \
  -Dsonar.pullrequest.key=123 \
  -Dsonar.pullrequest.branch=feature/new-feature \
  -Dsonar.pullrequest.base=main