FileTransform@1 - 檔案轉換 v1 工作

發行項
04/29/2024

使用此工作將權杖取代為 XML 或 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.

輸入

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>.

xmlTransformationRules - 轉換規則
string. 選擇性。使用時機 enableXmlTransform == true 。預設值：-transform **\*.Release.config -xml **\*.config\n-transform **\*.$(Release.EnvironmentName).config -xml **\*.config。

使用語法提供分行符號分隔的轉換檔案規則清單：

-transform <pathToTransformFile> -xml <pathToSourceConfigurationFile>.

fileType - 檔案格式
string. 允許值：xml 和 json。

提供替代格式的檔案格式。

針對 XML，在組建或發行管線中定義的變數將會與 key 任何組態檔和的 appSettings 、 applicationSettings 和區 connectionStrings 段中的或 nameparameters.xml 專案進行比對。 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、傳統組建、傳統版本
執行于	Agent、DeploymentGroup
要求	無
Capabilities	此工作不符合作業中後續工作的任何需求。
命令限制	任何
Settable 變數	任何
代理程式版本	所有支援的代理程式版本。
工作類別	公用程式