如何在Azure DevOps发布流水线中修改YAML配置文件字段

1. 使用Bash脚本 + yq工具（推荐，跨平台且保留注释） #

yq是专门处理YAML/JSON的命令行工具，完全跨平台（支持Windows、Linux、macOS），默认保留源文件注释，适配你的场景需求。

操作步骤： #

• 在发布流水线中添加Bash任务（Linux/Windows代理均可运行）
• 若代理机器未预装yq，可在脚本中加入安装命令：

  # Linux/Debian/Ubuntu环境安装
  sudo apt update && sudo apt install yq -y
  # 通用二进制安装方式（适配更多环境）
  wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/bin/yq && chmod +x /usr/bin/yq
  

• 执行修改命令，直接引用流水线变量：

  # 示例：修改config.yaml中database.host字段为流水线变量DB_HOST的值
  yq eval '.database.host = "$(DB_HOST)"' config.yaml -i
  # 示例：修改顶级字段api_port
  yq eval '.api_port = $(API_PORT)' config.yaml -i
  

  注：-i参数表示直接修改源文件，无需输出到新文件。

2. 使用Python脚本 + ruamel.yaml库（保留注释） #

ruamel.yaml是PyYAML的增强版本，支持读取、修改YAML文件并完整保留原有注释、格式。

操作步骤： #

• 添加Python任务，选择适配的Python版本
• 先安装ruamel.yaml依赖：

  pip install ruamel.yaml
  

• 编写修改脚本（命名为modify_yaml.py）：

  from ruamel.yaml import YAML
  import os
  
  yaml = YAML()
  yaml.preserve_quotes = True  # 保留原文件的引号格式
  
  # 读取目标YAML文件
  with open('config.yaml', 'r') as f:
      config = yaml.load(f)
  
  # 修改指定字段，通过环境变量获取流水线变量值
  config['database']['host'] = os.environ['DB_HOST']
  config['api_port'] = int(os.environ['API_PORT'])
  
  # 写入修改后的内容，保留注释
  with open('config.yaml', 'w') as f:
      yaml.dump(config, f)
  

• 在Python任务中执行脚本：

  python modify_yaml.py
  

  注：流水线变量会自动注入任务的环境变量，直接通过os.environ调用即可。

3. 使用PowerShell Core脚本（跨平台） #

PowerShell Core支持跨平台运行，针对简单字段修改，可采用逐行替换的方式完全保留注释；若处理复杂层级字段，可结合powershell-yaml模块。

操作步骤： #

• 添加PowerShell任务，选择Core版本
• 安装powershell-yaml模块（若处理复杂层级时使用）：

  Install-Module -Name powershell-yaml -Force -Scope CurrentUser
  

• 逐行替换示例脚本（适合固定格式字段，完全保留注释）：

  # 读取YAML文件内容
  $content = Get-Content -Path "config.yaml" -Raw
  
  # 替换指定字段，引用流水线变量
  $content = $content -replace '^database.host:.*', "database.host: $(DB_HOST)"
  $content = $content -replace '^api_port:.*', "api_port: $(API_PORT)"
  
  # 将修改后的内容写回文件
  $content | Set-Content -Path "config.yaml"
  

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