如何在Jenkins多分支项目中通过Config File Provider获取属性文件键值

第一步：确认fileId的正确性 #

你怀疑fileId不正确是合理的，按以下步骤获取准确的fileId：

• 进入Jenkins后台的「Manage Jenkins」→「Managed files」
• 找到你创建的目标配置文件，点击文件名进入详情页
• 查看浏览器地址栏，URL末尾的id参数值就是正确的fileId（例如http://your-jenkins/configfiles/editConfigFile?id=xxxx-xxxx-xxxx中的xxxx-xxxx-xxxx）
• 也可以悬停在配置文件的「编辑」按钮上，查看链接的id参数，同样能拿到准确值

第二步：根据配置文件类型选择正确读取方式 #

Config File Provider Plugin的variable参数返回的是配置文件在代理节点上的临时路径，不是直接解析好的键值对象，所以你原代码中直接调用${MY_PROPS.NETLIFY_SITE_ID}是无效的，需根据文件类型处理：

场景1：配置文件是Properties格式（如NETLIFY_SITE_ID=abc123） #

有两种常用读取方式：

stage('feature') {
  when{
    branch 'feature/*'
  }
  steps {
    configFileProvider([configFile(fileId: '你的正确fileId', variable: 'PROPS_FILE_PATH')]) {
        // 方式1：加载为环境变量
        load "${PROPS_FILE_PATH}"
        sh "echo \$NETLIFY_SITE_ID"

        // 方式2：解析为Groovy对象
        def props = readProperties file: PROPS_FILE_PATH
        echo "NETLIFY_SITE_ID: ${props['NETLIFY_SITE_ID']}"
        sh "echo ${props['NETLIFY_SITE_ID']}"
    }
  }
}

场景2：配置文件是JSON格式（如{"NETLIFY_SITE_ID": "abc123"}） #

用readJSON步骤解析文件：

stage('feature') {
  when{
    branch 'feature/*'
  }
  steps {
    configFileProvider([configFile(fileId: '你的正确fileId', variable: 'JSON_FILE_PATH')]) {
        def jsonData = readJSON file: JSON_FILE_PATH
        echo "NETLIFY_SITE_ID: ${jsonData.NETLIFY_SITE_ID}"
        sh "echo ${jsonData.NETLIFY_SITE_ID}"
    }
  }
}

额外注意事项 #

• 确认配置文件内容格式无误，比如Properties文件不要有多余空格、JSON文件语法正确
• 多分支项目需检查配置文件是否设置了分支访问限制，确保当前feature/*分支有权限读取
• shell步骤中引用Groovy变量时，若变量包含特殊字符，建议用环境变量传递的方式避免转义问题

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