SonarQube与Jenkins、GitHub集成：指定Git仓库代码扫描路径

嗨，我来帮你理清这个配置逻辑！其实你不用直接让Sonar Scanner去扫远程Git仓库——Jenkins在构建触发时，已经会自动把Git仓库的代码拉取到Jenkins服务器的工作目录里了，你只需要让Sonar Scanner指向这个本地工作目录里的代码就行，具体配置步骤如下：

核心逻辑说明 #

Jenkins的Git源码管理步骤会在每次构建时，把你指定的Git仓库分支代码克隆/拉取到Jenkins的${WORKSPACE}环境变量对应的本地目录中。Sonar Scanner是在Jenkins服务器上运行的，它只能扫描本地文件系统的代码，所以我们只需要配置它指向这个工作目录下的代码路径即可。

具体配置方法 #

1. 确保Jenkins已经配置Git源码拉取 #

先确认你的Jenkins任务已经正确添加了Git源码管理：

• 填入你的Git仓库地址、认证信息（比如SSH密钥或账号密码）
• 指定要拉取的分支（比如main或develop）
  这样构建时Jenkins会自动把代码同步到本地工作区。

2. 配置sonar.sources属性 #

在Jenkins的Sonar Scanner构建步骤中，找到Analysis properties区域，按照你的需求设置sonar.sources：

• 如果要扫描整个Git仓库的所有代码，直接用相对路径：

  sonar.sources=.
  

  这里的.代表当前工作目录（也就是Jenkins拉取代码后的根目录）
• 如果只需要扫描特定子目录，比如项目的Java源码目录：

  sonar.sources=src/main/java
  

• 也可以结合Jenkins环境变量明确指定路径（相对路径更简洁，推荐用上面的方式）：

  sonar.sources=${WORKSPACE}/src
  

3. 完整的常用配置示例 #

通常你还需要补充其他必要的SonarQube配置，比如项目Key、服务器地址、认证令牌，完整的Analysis properties示例：

sonar.projectKey=my-project-key  # 替换成你在SonarQube中创建的项目Key
sonar.sources=.
sonar.host.url=http://your-sonarqube-server:9000  # 替换成你的SonarQube服务器地址
sonar.login=your-sonarqube-token  # 替换成你的SonarQube认证令牌

4. 更灵活的方式：使用sonar-project.properties文件 #

如果你不想在Jenkins构建步骤里硬编码配置，可以在Git仓库的根目录下创建一个sonar-project.properties文件，把所有配置写在里面：

sonar.projectKey=my-project-key
sonar.sources=.
sonar.host.url=http://your-sonarqube-server:9000
sonar.login=your-sonarqube-token

这样Jenkins的Sonar Scanner在运行时会自动读取这个文件里的配置，不用在Jenkins里重复设置，更适合多环境复用。

常见误区提醒 #

不要试图把sonar.sources设置为Git仓库的URL（比如git@github.com:xxx/xxx.git），Sonar Scanner不支持直接扫描远程仓库，必须基于本地文件系统的代码进行分析——这也是Jenkins先拉取代码再扫描的标准流程。

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