FileTransform@1 - 文件转换 v1 任务

使用此任务可将令牌替换为 XML 或 JSON 配置文件中的变量值。

此版本的任务已弃用;使用 FileTransform@2

使用此任务可将令牌替换为 XML 或 JSON 配置文件中的变量值。

语法

# File transform v1
# Replace tokens with variable values in XML or JSON configuration files.
- task: FileTransform@1
  inputs:
    folderPath: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #enableXmlTransform: false # boolean. XML transformation. Default: false.
    #xmlTransformationRules: '-transform **\*.Release.config -xml **\*.config' # string. Optional. Use when enableXmlTransform == true. Transformation rules. Default: -transform **\*.Release.config -xml **\*.config.
  # Variable Substitution
    #fileType: # 'xml' | 'json'. File format. 
    #targetFiles: # string. Optional. Use when fileType = xml || fileType = json. Target files.

输入

folderPath - 包或文件夹
string。 必填。 默认值:$(System.DefaultWorkingDirectory)/**/*.zip

包或文件夹的文件路径。

变量 生成发布。 支持通配符。

例如,$(System.DefaultWorkingDirectory)/**/*.zip


enableXmlTransform - XML 转换
boolean。 默认值:false

配置转换将在变量替换之前运行。

XML 转换仅适用于 Windows 平台。


xmlTransformationRules - 转换规则
string。 可选。 当 enableXmlTransform == true时使用。 默认值:-transform **\*.Release.config -xml **\*.config

使用语法提供转换文件规则的新行分隔列表:

-transform <pathToTransformFile> -xml <pathToSourceConfigurationFile>


fileType - 文件格式
string。 允许的值:xmljson

提供替换格式的文件格式。

对于 XML,在生成或发布管道中定义的变量将与任何配置文件和 parameters.xmlappSettingsapplicationSettingsconnectionStrings 节中的 keyname 项匹配。 Variable Substitution 在配置转换后运行。

若要替换嵌套或分层的 JSON 变量,请使用 JSONPath 表达式指定它们。

例如,若要替换以下示例中 ConnectionString 的值,需要在生成或发布管道(或发布管道的环境)中将变量定义为 Data.DefaultConnection.ConnectionString

{
  "Data": {
    "DefaultConnection": {
      "ConnectionString": "Server=(localdb)\SQLEXPRESS;Database=MyDB;Trusted_Connection=True"
    }
  }
}

变量替换在配置转换后运行。

注意:仅在生成/发布管道中定义的自定义变量用于替换。 排除默认/系统定义的管道变量。 如果在发布管道和阶段中定义了相同的变量,则阶段变量将取代发布管道变量。


targetFiles - 目标文件
string。 可选。 当 fileType = xml || fileType = json时使用。

提供换行分隔的文件列表,以替换变量值。 文件名相对于根文件夹提供。


任务控制选项

除任务输入之外,所有任务都具有控制选项。 有关详细信息,请参阅 控件选项和常见任务属性

输出变量

没有。

注解

FileTransform@2中提供了此任务的较新版本。

要求

要求 说明
管道类型 YAML,经典版本,经典版本
运行时间 代理,DeploymentGroup
需求 没有
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任何
Settable 变量 任何
代理版本 所有支持的代理版本。
任务类别 效用