Github Actions CI/CD中SonarCloud任务BuildConfig字段未解析求助

在多产品风味的Android项目中，通过Github Actions执行SonarCloud的Build and Analyze阶段时，出现编译错误：

e: file:///home/runner/work/mo-android/mo-android/app/src/main/java/menu/quor/wrappers/BuildConfigWrapper.kt:13:39 Unresolved reference: VERSION_NAME
e: file:///home/runner/work/mo-android/mo-android/app/src/main/java/menu/quor/wrappers/BuildConfigWrapper.kt:25:40 Unresolved reference: VERSION_CODE

问题原因 #

项目存在多个产品风味（productFlavors），每个风味定义了独立的versionCode和versionName，但Github Actions中执行的Gradle任务存在以下问题：

1. Build Sandbox步骤中的命令./gradlew build[required variant]是占位符，未替换为实际变体任务，导致该步骤未正确生成对应变体的BuildConfig。
2. Build and Analyze步骤直接执行./gradlew build sonarqube --info，会尝试构建所有变体，SonarCloud分析时无法定位到正确的BuildConfig文件，导致字段未解析。

解决方案 #

1. 修正Github Actions中的Gradle命令 #

• 替换Build Sandbox步骤的命令为具体变体的组装任务（根据你需要分析的变体调整，例如flavour1Debug）：

  ./gradlew assembleFlavour1Debug
  

• 修改Build and Analyze步骤的命令，指定具体变体+sonarqube任务，避免构建所有变体：

  ./gradlew assembleFlavour1Debug sonarqube --info
  

2. 优化产品风味名称（可选但推荐） #

Gradle中带空格的风味名称会导致任务名称解析复杂，建议将风味名称改为无空格格式：

productFlavors {
    create("flavour1") {
        applicationId = "com.flavour.one"
        targetSdk = 30
        minSdk = 26
        versionCode = 10
        versionName = "1.0.0"
        dimension = "minApi"
   
        resValue("string", "app_name", "Sandbox")
        resValue("color", "splashbackgroundcolor", "#ff0d0d0d")
    }

    create("flavour2") {
        applicationId = "com.flavour.two"
        targetSdk = 33
        minSdk = 26
        versionCode = 36
        versionName = "4.0.0"
        dimension = "minApi"
        resValue("string", "app_name", "Sandbox")
        resValue("color", "splashbackgroundcolor", "#ff0d0d0d")
    }

    create("flavour3") {
        applicationId = "com.flavour.three"
        targetSdk = 34
        minSdk = 24
        dimension = "minApi"
        versionCode = 90
        versionName = "2024.5"
        resValue ("color", "splashbackgroundcolor", "#ff0d0d0d")
    }
}

3. 验证BuildConfig导入 #

确保BuildConfigWrapper.kt中导入的是对应变体的BuildConfig类，例如使用flavour1变体时：

import com.flavour.one.BuildConfig

4. 配置任务依赖（可选） #

在模块的build.gradle中添加任务依赖，确保sonarqube执行前自动构建指定变体：

tasks.sonarqube.dependsOn('assembleFlavour1Debug')

这样配置后，执行sonarqube任务时会自动先构建目标变体，生成正确的BuildConfig文件，解决字段未解析的问题。

内容的提问来源于stack exchange，提问作者DJ-DOO