Jenkins流水线使用readProperties读取属性文件报编译错误如何解决

错误原因 #

报错Expected a step的核心原因是声明式Jenkins流水线的steps代码块中，仅支持直接调用Jenkins官方或插件提供的流水线步骤，不允许直接编写Groovy变量定义、逻辑判断这类原生脚本代码。另外你报错日志中显示的代码行末尾多了一个冗余单引号，也会触发语法编译错误。

解决步骤 #

• 步骤1：调整流水线语法，将包含变量定义的脚本代码包裹在script块中，正确示例如下：

pipeline {
    agent any
    stages {
        stage('读取配置') {
            steps {
                script {
                    // 修正参数格式，file和冒号之间不要留空格，修正单引号闭合问题
                    def properties = readProperties file: 'my.properties'
                    // 后续正常使用属性值即可
                    echo "读取到的配置项：${properties.testKey}"
                }
            }
        }
    }
}

• 步骤2：确认依赖插件安装正确
  readProperties步骤由Pipeline Utility Steps插件提供，你安装的Utilities API只是该插件的依赖组件，需要在Jenkins插件管理中确认Pipeline Utility Steps插件已安装且启用，安装后重启Jenkins确保生效。
• 步骤3：校验属性文件路径
  确认my.properties文件位于当前流水线工作区根目录，如果文件在子目录下需要填写完整相对路径，比如file: 'config/my.properties'。

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