Jenkins流水线动态配置SonarQube项目版本号异常排查

问题根因 #

版本显示异常由两个核心问题导致：

1. 变量作用域错误：在script{}闭包内用def声明的myfile是块级局部变量，仅在当前script块内可访问，Sonar配置段不在该作用域范围内时，Groovy无法识别变量，会直接将myfile作为普通字符串解析，最终Sonar端显示异常文本。
2. 读取内容带冗余字符：readFile方法读取文件时会保留文件末尾的换行符、首尾空白字符，未做处理的内容传入Sonar后也会出现显示不符合预期的问题。

正确实现方式 #

核心规则 #

• 跨stage使用的变量不要用def声明为局部变量，建议存入流水线环境变量，全局可访问
• 读取version.txt内容后必须调用trim()方法去除首尾冗余的换行、空格
• 优先通过sonar-scanner命令行参数传入版本号，参数优先级高于静态配置文件，避免配置冲突

可直接复用的流水线示例 #

pipeline {
    agent any
    environment {
        // 定义全局环境变量存储版本号，全流水线可访问
        PROJECT_VERSION = ''
    }
    stages {
        stage('读取项目版本') {
            steps {
                script {
                    // 用def声明的rawVersion是当前script块内临时变量，仅用于读取处理
                    def rawContent = readFile(file: 'Src/version.txt')
                    // 处理后赋值给全局环境变量
                    PROJECT_VERSION = rawContent.trim()
                    echo "当前构建版本号：${PROJECT_VERSION}"
                }
            }
        }
        stage('SonarQube代码扫描') {
            steps {
                withSonarQubeEnv('你在Jenkins中配置的SonarQube服务名') {
                    // Windows节点用bat，Linux节点替换为sh
                    bat """
                    sonar-scanner.bat -D"sonar.projectKey=你的项目唯一Key" ^
                    -D"sonar.sources=源码目录" ^
                    -D"sonar.projectVersion=${PROJECT_VERSION}"
                    """
                }
            }
        }
    }
}

避坑说明 #

• 不要写死Jenkins工作空间绝对路径（比如示例中的C:/Jenkins/workspace/xxx），步骤执行时默认工作目录为当前任务的工作空间根目录，使用相对路径即可适配不同构建节点、不同工作空间分配规则的场景
• 如果你习惯用项目下的sonar-project.properties文件配置Sonar参数，不需要在文件中写死sonar.projectVersion配置，命令行传入的参数会自动覆盖配置文件中的同名配置
• 配置完成后可先在Sonar扫描步骤前加echo打印PROJECT_VERSION变量，确认变量值在扫描阶段可正常输出，先排除作用域问题再执行扫描

内容的提问来源于stack exchange，提问作者G.A