Compartilhar via


FileTransform@1 – Tarefa de transformação de arquivo v1

Use essa tarefa para substituir tokens por valores variáveis em arquivos de configuração XML ou JSON.

Syntax

# 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.
# 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: # string. Optional. Use when enableXmlTransform == true. Transformation rules. 
  # Variable Substitution
    #fileType: # 'xml' | 'json'. File format. 
    #targetFiles: # string. Optional. Use when fileType = xml || fileType = json. Target files.

Entradas

folderPath - Pacote ou pasta
string. Obrigatórios. Valor padrão: $(System.DefaultWorkingDirectory)/**/*.zip.

O caminho do arquivo para o pacote ou uma pasta.

As variáveis são Build e Versão. Há suporte para caracteres curinga.

Por exemplo, $(System.DefaultWorkingDirectory)/**/*.zip.


enableXmlTransform - Transformação XML
boolean. Valor padrão: false.

As transformações de configuração serão executadas antes da Substituição variável.

As transformações XML têm suporte apenas para a plataforma Windows.


xmlTransformationRules - Regras de transformação
string. Opcional. Use quando enableXmlTransform == true. Valor padrão: -transform **\*.Release.config -xml **\*.config.

Fornece uma nova lista separada por linhas de regras de arquivo de transformação usando a sintaxe :

-transform <pathToTransformFile> -xml <pathToSourceConfigurationFile>.


xmlTransformationRules - Regras de transformação
string. Opcional. Use quando enableXmlTransform == true. Valor padrão: -transform **\*.Release.config -xml **\*.config\n-transform **\*.$(Release.EnvironmentName).config -xml **\*.config.

Fornece uma lista separada por nova linha de regras de arquivo de transformação usando a sintaxe :

-transform <pathToTransformFile> -xml <pathToSourceConfigurationFile>.


fileType - Formato de arquivo
string. Valores Permitidos: xml e json.

Fornece o formato de arquivo no qual a substituição é perfformada.

Para XML, as variáveis definidas nos pipelines de build ou de lançamento serão correspondidas key às entradas ou name nas appSettingsseções , applicationSettingse connectionStrings de qualquer arquivo de configuração e parameters.xml. Variable Substitution é executado após transformações de configuração.

Para substituir variáveis JSON aninhadas ou hierárquicas, especifique-as usando expressões JSONPath.

Por exemplo, para substituir o valor de ConnectionString no exemplo abaixo, você precisa definir uma variável como Data.DefaultConnection.ConnectionString no pipeline de build ou lançamento (ou no ambiente do pipeline de lançamento).

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

A substituição de variável é executada após transformações de configuração.

Observação: somente variáveis personalizadas definidas em pipelines de build/lançamento são usadas na substituição. Variáveis de pipeline padrão/definidas pelo sistema são excluídas. Se as mesmas variáveis forem definidas no pipeline de lançamento e no estágio, as variáveis de estágio substituirão as variáveis de pipeline de lançamento.


targetFiles - Arquivos de destino
string. Opcional. Use quando fileType = xml || fileType = json.

Fornece uma lista separada por nova linha de arquivos para substituir os valores de variável. Os nomes de arquivo devem ser fornecidos em relação à pasta raiz.


Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

Há uma versão mais recente dessa tarefa disponível em FileTransform@2.

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Executa em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente Todas as versões do agente com suporte.
Categoria da tarefa Utilitário