使用Azure YAML流水线复制web.config时删除特定注释行

需求 #

复制web.config文件到工件目录时，自动移除文件内的XML注释行（即<!-- ... -->格式的内容）

实际文件内容 #

<service behaviorConfiguration="mybehavior" name="">
     <endpoint address="" binding="netTcpBinding" bindingConfiguration="" contract=""/>
     <!--<endpoint address="mex" binding="mexTcpBinding" contract="IMetadataExchange"/>-->
 </service>
<service behaviorConfiguration="mybehavior" name="">
     <endpoint address="" binding="netTcpBinding" bindingConfiguration="" contract=""/>
     <!--<endpoint address="mex" binding="mexTcpBinding" contract="IMetadataExchange"/>-->
 </service>

期望处理后内容 #

<service behaviorConfiguration="mybehavior" name="">
     <endpoint address="" binding="netTcpBinding" bindingConfiguration="" contract=""/>
 </service>
<service behaviorConfiguration="mybehavior" name="">
     <endpoint address="" binding="netTcpBinding" bindingConfiguration="" contract=""/>
 </service>

当前流水线任务 #

- task: CopyFiles@2
    displayName: Copy web config into the Package
    condition: eq(variables.generateConfigs, true)
    inputs:
      SourceFolder: '$(ReleasesPath.SourceFolderName)'
      Contents: |
        Web.config
      TargetFolder: '$(CopyPath.TragetFolderName)'
      CleanTargetFolder: false
      preserveTimestamp: true

解决方案 #

CopyFiles@2任务仅负责文件复制，无法修改内容。需添加PowerShell任务来处理web.config，移除注释行，以下是两种可行方案：

方案1：先处理源文件再复制（允许修改源文件时使用） #

- task: PowerShell@2
  displayName: 移除web.config中的注释行
  condition: eq(variables.generateConfigs, true)
  inputs:
    targetType: 'inline'
    script: |
      $webConfigPath = "$(ReleasesPath.SourceFolderName)\Web.config"
      # 读取文件内容，移除XML注释并清理空行
      $content = Get-Content -Path $webConfigPath -Raw
      $content = $content -replace '<!--.*?-->','' -replace '\n\s*\n',"`n"
      Set-Content -Path $webConfigPath -Value $content -Encoding UTF8

# 原复制任务保留
- task: CopyFiles@2
    displayName: Copy web config into the Package
    condition: eq(variables.generateConfigs, true)
    inputs:
      SourceFolder: '$(ReleasesPath.SourceFolderName)'
      Contents: |
        Web.config
      TargetFolder: '$(CopyPath.TragetFolderName)'
      CleanTargetFolder: false
      preserveTimestamp: true

方案2：先复制再处理目标文件（不修改源文件时使用） #

# 原复制任务保留
- task: CopyFiles@2
    displayName: Copy web config into the Package
    condition: eq(variables.generateConfigs, true)
    inputs:
      SourceFolder: '$(ReleasesPath.SourceFolderName)'
      Contents: |
        Web.config
      TargetFolder: '$(CopyPath.TragetFolderName)'
      CleanTargetFolder: false
      preserveTimestamp: true

# 添加处理任务
- task: PowerShell@2
  displayName: 移除目标目录web.config中的注释行
  condition: eq(variables.generateConfigs, true)
  inputs:
    targetType: 'inline'
    script: |
      $webConfigPath = "$(CopyPath.TragetFolderName)\Web.config"
      # 读取文件内容，移除XML注释并清理空行
      $content = Get-Content -Path $webConfigPath -Raw
      $content = $content -replace '<!--.*?-->','' -replace '\n\s*\n',"`n"
      Set-Content -Path $webConfigPath -Value $content -Encoding UTF8

脚本说明 #

• <!--.*?-->：非贪婪匹配所有XML注释内容，避免误删多行内容
• \n\s*\n：匹配注释删除后留下的空行，替换为单个换行符，保持文件格式整洁

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