File Content Replacer
File Content Replacer is the build feature which p rocesses text files by performing regular expression replacements before a build. After the build, it r estores the file content to the original state.
The common case of using File Content Replacer is replacing one attribute at a time in particular files , e.g. it can be used to patch files with the build number.
You can add more than one File Content Replacer build feature if you wish to:
replace more than one attribute,
replace one and the same attribute in different files/projects with different values.
This feature extends the capabilities provided by AssemblyInfo Patcher.
Check the Adding Build Features section for notes on how to add a build feature.
File Content Replacer Settings
You can specify the values manually or use value presets for replacement, which can be edited if needed.
Option | Description |
|---|---|
Template (optional): | File Content Replacer provides a template for every attribute to be replaced. Clicking the Load Template... button displays the combobox with templates containing value presets for replacement. The templates can be filtered by language (e.g. |
Process files: | Click Edit file list and specify paths to files where the values to be replaced will be searched. Provide a newline- or comma-separated set of rules in the form of +|-:[path relative to the checkout directory] . Ant-like wildcards are supported, e.g. dir/**/*.cs. If a is selected, the files associated with that template will be used. |
File encoding: | By default, TeamCity will auto-detect the file encoding. To specify the encoding explicitly, select it from the drop-down. When specifying a custom encoding, make sure it is supported by the agent. If a is selected, the file encoding associated with that template will be used. |
Find what: | Specify a pattern to search for, in the regular expression format. MULTILINE mode is on by default. If a is selected, the pattern associated with that template will be used. |
Match case: | By default, the comparison is case-sensitive. Uncheck for case-insensitive languages. If a is selected, the comparison associated with that template will be used. |
Regex: | Since TeamCity 2017.1 The box is checked by default and applies to both the search and replacement strings. Uncheck to use fixed strings. |
Replace with: | Type the text to be used for replacing the characters in the Find what box. To delete the characters in the Find what box from your file, leave this box blank. $N sequence references N-th capturing group. All backslashes (\) and dollar signs ($) without a special meaning should be quoted (as \\ and \$, respectively). |
Pre-defined templates
Templates
This section lists the available replacement templates.
.NET templates
The templates for replacing the following Assembly attributes are provided (see this section for comparison with AssemblyInfo Patcher):
.Net Core csproj templates
The csprojformat is supported since TeamCity 2017.1:
AssemblyNameAssemblyTitleAssemblyVersionAuthorsCompanyCopyrightDescriptionFileVersionPackageIdPackageVersionProductTitleVersionVersionPrefixVersionSuffix
MFC templates
The templates for replacing the following MFC C++ resource keys are are provided:
FileDescriptionCompanyNameProductNameLegalCopyrightFileVersion*ProductVersion*
Xcode templates
The templates for replacing the following https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html in Info.plist files are provided:
CFBundleVersionCFBundleShortVersionStringor both
CFBundleVersionandCFBundleShortVersionStringat the same time
Examples
Extending an attribute value with a custom suffix
Suppose you do not want to replace your AssemblyConfiguration with a fixed literal, but want to preserve your AssemblyConfiguration from AssemblyInfo.cs and just extend it with a custom suffix, e.g.: [assembly: AssemblyConfiguration("${AssemblyConfiguration} built by TeamCity")])
Do the following: For changing complex regex patterns, this external tool might be useful.
Patching only specified files
The default AssemblyInfo templates follow the usual Visual Studio project/solution layout; but a lot of information may be shared across multiple projects and can reside in a shared file (e.g. CommonAssemblyInfo.cs).
Suppose you want to patch this shared file only; or you want to patch AssemblyInfo.cs files on a per-project bassis.
Do the following:
Load the
AssemblyInfotemplate corresponding to the attribute you are trying to process (e.g.AssemblyVersion)Change the list of file paths in the Wildcards field from the default
* /Properties/AssemblyInfo.csto* /CommonAssemblyInfo.csor list several files comma- or new-line separated files here, e.g.myproject1/Properties/AssemblyInfo.cs, myproject2/Properties/AssemblyInfo.cs.
Specifying path patterns which contain spaces
Spaces are usually considered a part of the pattern, unless they follow a comma, as the comma is recognised as a delimiter.
Note that the TeamCity server UI trims leading and trailing spaces in input fields, so a single-line pattern like <spaces>foo.bar will become foo.bar upon save. The following workarounds are available:
Changing only the last version part / build number of the AssemblyVersion attribute:
Suppose, your AssemblyVersion in AssemblyInfo.cs is Major.Minor.Revision.Build (set to 1.2.3.*) , and you want to replace the Build portion (following the last dot (the *) only.
Load the
AssemblyVersionin AssemblyInfo (C#)_ template and change the default pattern:(^\s*\[\s*assembly\s*:\s*((System\s*\.)?\s*Reflection\s*\.)?\s*AssemblyVersion(Attribute)?\s*\(\s*@?\")(([0-9\*])+\.?)+(\"\s*\)\s*\])to
(^\s*\[\s*assembly\s*:\s*((System\s*\.)?\s*Reflection\s*\.)?\s*AssemblyVersion(Attribute)?\s*\(\s*@?\")(([0-9\*]+\.)+)[0-9\*]+(\"\s*\)\s*\])and change the default replacement:
$1\%build.number%$7to
$1$5\%build.number%$7.