Build Step - Search And Replace

This Build Step Dialog allows you to edit the general properties of this step, as well as the Search And Replace parameters that will control this Step.

Field Definitions

• ID This is a read-only field that displays the ID for this Build Step which is unique throughout the system.
• Name This is the name of your build step and is displayed in the Build Editor Build Steps table, as well as in the Build History view.
• Type This is a read-only field that displays what type of Build Step this is.
• Execute On Server This field allows you to set up Remote Execution of build steps. It will default to the current server, but if you have more than one Build Server defined, you may pick from any server to choose where this Build Step will run.
• Timeout This is the amount of time (in Minutes) that this step will be allowed to run. If this Step does not complete in the given amount of time, it will be canceled and the Step will be marked as Failed.
• Execute Step in Parallel This indicates whether this Step will be Run in Parallel with the subsequent step. If so, this step will be run on a separate thread from the subsequent step.
• Stop Build if Step Fails This indicates whether a failure of this Step should halt the entire Build.
• Working Dir This is the Directory in which this Build Step will execute. You may use the value ${WORKDIR} to pick up the Build's Working Directory, or specify a different one as required.
• Create if Missing This is a flag that tells the build execution engine to create this Step Working Directory if it is missing. If the directory does not exist and this flag is not set, then this Step will fail.
• Erase Before Build This is a flag that tells the build execution engine to completely erase any files or folders that it finds inside the working directory prior to starting this Step. If this flag is not checked then any contents inside your working directory will be left as-is when the Step starts.
• Recurse Into Subdirectories This indicates whether the Search And Replace process will only affect the Step Working Directory, or whether it will also descend into any subdirectories that are found in the Working Directory.
• Replace Text This is the string that will be searched for in all of the files examined. If the Use Regular Expressions flag is turned on, then this value will be interpreted as a Regular Expression when searching through the files.
• With Text If the Replace Text is found, then this field defines what text will be used to replace it. You may use Replacement Variables in this setting.
• In Files This lists the file name patterns that will define which files are examined during the scan. You may list multiple patterns in this field separated by commas. e.g. "*.cpp,*.html,*.cs"
• Use Regular Expressions This field determines whether Regular Expression matching will be used when searching for the Replace Text value in the files that are examined.