Sonarqube-community-branch-plugin 与 SonarQube 25.x 版本的兼容性指南

背景介绍

Sonarqube-community-branch-plugin 是一个为 SonarQube 社区版提供分支和拉取请求分析功能的插件。随着 SonarQube 25.x 系列的发布，许多用户在升级过程中遇到了插件兼容性问题。本文将详细介绍如何在不同版本的 SonarQube 25.x 上正确配置和使用该插件。

版本兼容性现状

根据社区反馈和实际测试，目前可以确认以下版本组合是可行的：

• SonarQube 25.1.0 与 1.23.0 版本插件
• SonarQube 25.2.0 与 1.23.0 版本插件

需要注意的是，SonarQube 25.3.0 目前与 1.23.0 版本插件存在兼容性问题，分支分析功能无法正常工作。

常见问题解决方案

Java Agent 配置问题

在 SonarQube 25.x 版本中，1.23.0 版本的插件对 Java Agent 的配置有严格要求。如果配置不正确，会导致以下错误：

java.lang.IllegalStateException: The plugin did not detect agent modifications so SonarQube is unlikely to work with Pull Requests or Branches. Please check the Java Agent has been correctly set for the SERVER component

解决方案是确保在启动参数中正确配置 Java Agent：

1. 对于 Web 组件：

-Dsonar.web.javaAdditionalOpts="-javaagent:/path/to/sonarqube-community-branch-plugin-1.23.0.jar=web"

2. 对于计算引擎(CE)组件：

-Dsonar.ce.javaAdditionalOpts="-javaagent:/path/to/sonarqube-community-branch-plugin-1.23.0.jar=ce"

升级路径建议

从旧版本升级时，建议采用以下路径：

1. 9.9.x LTS → 10.7.x
2. 10.7.x → 24.12.x
3. 24.12.x → 25.1.x

虽然直接升级到最新版本可能也能工作，但分阶段升级可以降低风险。

功能配置技巧

Azure DevOps 集成

成功安装插件后，可以在项目设置中配置 Azure DevOps 集成。确保在分析时提供以下参数：

sonar.pullrequest.key=<PR编号>
sonar.pullrequest.branch=<分支名称>
sonar.pullrequest.base=<目标分支>

GitLab 集成

对于 GitLab 集成，除了插件安装外，还需要通过 API 设置 ALM 绑定：

curl -u <token>: -X POST "<sonarqube_url>/api/alm_settings/set_gitlab_binding?almSetting=Gitlab&project=<project_path>&repository=<project_id>&monorepo=false"

注意事项

1. 全新安装与升级的区别：全新安装通常问题较少，而从旧版本升级可能需要额外的配置调整。

2. 插件加载机制变化：1.23.0 版本引入了更严格的 Java Agent 检测机制，这是与早期版本的主要区别。

3. 管理界面变化：SonarQube 25.x 版本中，部分管理界面选项位置有所调整，需要适应新的布局。

总结

Sonarqube-community-branch-plugin 1.23.0 版本与 SonarQube 25.1 和 25.2 版本兼容性良好，但在 25.3 版本上存在问题。正确的 Java Agent 配置是确保插件正常工作的关键。对于生产环境，建议在升级前进行全面测试，并考虑采用分阶段升级策略以降低风险。