task.json

{
  "id": "9240B5C1-A1B2-4799-9325-E071C63236FB",
  "name": "ReplaceTokens",
  "friendlyName": "Replace Tokens",
  "description": "Replaces tokens in a file using RegEx. Values come from any variable defined in the current Environment.",
  "author": "Colin Dembovsky (colinsalmcorner.com)",
  "helpMarkDown": "[More Information](https://github.com/colindembovsky/cols-agent-tasks/tree/master/Tasks/ReplaceTokens)",
  "category": "Utility",
  "visibility": [
    "Build",
    "Release"
  ],
  "version": {
    "Major": "1",
    "Minor": "2",
    "Patch": "28"
  },
  "groups": [
    {
      "name": "advanced",
      "displayName": "Advanced",
      "isExpanded": false
    }
  ],
  "minimumAgentVersion": "1.91.0",
  "instanceNameFormat": "Replace tokens in $(sourcePath)",
  "inputs": [
    {
      "name": "sourcePath",
      "type": "filePath",
      "label": "Source Path",
      "defaultValue": "",
      "helpMarkDown": "Path to the file(s) containing tokens. Leave empty to use the sources directory. NOTE: this is case sensitive for non-Windows systems. This should be a path containing the file, not the file itself.",
      "required": false
    },
    {
      "name": "filePattern",
      "type": "string",
      "label": "Target File Pattern",
      "defaultValue": "*.config",
      "helpMarkDown": "File pattern to find in source path. Supports minimatch. NOTE: this is case sensitive for non-Windows systems.",
      "required": true
    },
    {
      "name": "warningsAsErrors",
      "type": "boolean",
      "label": "Treat warnings as errors",
      "defaultValue": false,
      "helpMarkDown": "When switched to true, warnings are treated as errors causing breakage of build."
    },
    {
      "name": "tokenRegex",
      "type": "string",
      "label": "Token Regex",
      "defaultValue": "__(\\w+)__",
      "helpMarkDown": "Regex to use for token replacement. Must include a group match.",
      "required": true,
      "groupName": "advanced"
    },
    {
      "name": "secretTokens",
      "type": "string",
      "label": "Secret Tokens (only for TFS 2015)",
      "defaultValue": "",
      "helpMarkDown": "A configuration variable can be set as 'secret' in release definition to have its value hidden. For tokens need to be replaced with the value of secret configuration variables, they can be specified here using the following format: key1:$(secret1);key2:$(secret2). Non-secret configuration variable do not need to be specified explicitly here.",
      "required": false,
      "groupName": "advanced"
    }
  ],
  "execution": {
    "Node16": {
      "target": "replaceTokens.js",
      "argumentFormat": ""
    }
  }
}