如何在AWS CodeBuild中动态传递Sonar PR装饰的sonar.pullrequest.key

核心思路 #

AWS CodeBuild在触发PR构建时会自动注入特定环境变量，我们可以从中提取PR编号，然后在Sonar分析命令中动态传递该编号，覆盖sonar-project.properties里的静态配置。

具体步骤 #

1. 从CodeBuild环境变量提取PR编号
   当CodeBuild由GitHub PR触发时，环境变量CODEBUILD_SOURCE_VERSION的值格式为pr/<PR_NUMBER>。可以用Shell命令提取PR编号：

   # 仅在PR构建时提取编号
   if [[ "$CODEBUILD_SOURCE_VERSION" == pr/* ]]; then
       PR_NUMBER=$(echo "$CODEBUILD_SOURCE_VERSION" | cut -d'/' -f2)
   fi
   

2. 修改Sonar分析命令，动态传递参数
   可以直接移除sonar-project.properties中静态的sonar.pullrequest.key配置，在sonar-scanner命令中通过-D参数动态传入编号：

   sonar-scanner \
     -Dsonar.pullrequest.provider=GitHub \
     -Dsonar.pullrequest.github.repository=<your-repo> \
     -Dsonar.pullrequest.base=main \
     -Dsonar.pullrequest.branch=feature/* \
     -Dsonar.pullrequest.key=$PR_NUMBER
   

   如果sonar-project.properties中已配置其他PR相关参数，也可以仅覆盖key参数：

   sonar-scanner -Dsonar.pullrequest.key=$PR_NUMBER
   

3. 确认CodeBuild触发配置
   你的CodeBuild项目需要配置为由GitHub的Pull Request事件触发，这样CODEBUILD_SOURCE_VERSION才会包含PR编号信息。在CodeBuild控制台的项目构建触发器中，选择GitHub源并勾选PR相关触发条件即可。

额外说明 #

• 若使用Docker容器运行sonar-scanner，CodeBuild默认会将环境变量传递给构建容器，无需额外配置即可获取到PR_NUMBER。
• 确保Sonar服务器已配置好GitHub集成所需的OAuth令牌，保证能正常访问GitHub的PR数据。

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