DevOps集成SonarQube的Pipeline触发PR构建时报找不到目标分支错误

错误原因 #

该错误出现在PR合并前的SonarQube扫描场景中，核心原因是SonarScanner没有正确获取到PR对应的目标分支参数，导致传入Sonar服务端的目标分支值为null。
对应的错误日志如下：

{"task":{"id":"AXuKvrZjTmGb5CxwFPXc","type":"REPORT","componentId":"AXuKvrZYTmGb5CxwFPXb","componentKey":"Portal.API","componentName":"Portal.API","componentQualifier":"TRK","status":"FAILED","submittedAt":"2021-08-28T03:12:39+0000","submitterLogin":"myemail@email.com.br","startedAt":"2021-08-28T03:12:39+0000","executedAt":"2021-08-28T03:12:39+0000","executionTimeMs":30,"logs":false,"errorMessage":"Could not find target branch 'null' in project","hasScannerContext":true,"pullRequest":"198","warningCount":0,"warnings":[]}}

修复步骤 #

• 第一步：补全PR扫描的必填参数
  针对PR触发的扫描任务，必须在SonarScanner的执行参数中显式配置三个核心参数，所有参数值建议从DevOps平台的内置环境变量中读取，不要硬编码：
  • sonar.pullrequest.key：PR的唯一编号，本次报错对应的PR编号为198
  • sonar.pullrequest.branch：当前PR的源分支名称
  • sonar.pullrequest.base：PR要合并的目标分支名称，就是本次报错缺失的参数，需要正确赋值
• 第二步：确认SonarQube项目中已存在目标分支
  如果参数已经配置正确仍然报错，先手动触发一次目标分支的全量Sonar扫描，让SonarQube服务端留存该分支的记录，再重新运行PR的扫描任务。
• 第三步：区分扫描场景的参数配置
  不要混用PR扫描和普通分支扫描的参数：如果是普通分支推送触发的扫描，不要配置sonar.pullrequest.*系列参数，改用sonar.branch.name指定当前分支名即可，混用两种场景的参数也会导致目标分支识别异常。

内容的提问来源于stack exchange，提问作者Felipe Paulo