TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/FileContentReplacer

FileContentReplacer

open class FileContentReplacer : BuildFeature

fun BuildFeatures.replaceContent(init: FileContentReplacer.() -> Unit): FileContentReplacer

A build feature which processes text files by performing regular expressions

Example. Finds all the 'Properties/AssemblyInfo.cs' files on the agent under the build checkout directory and performs replacement there according to the provided regular explression. All the strings matched by the regexp will be replaced with the current build number.

/*

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        replaceContent {
          fileRules = "**/Properties/AssemblyInfo.cs"
           pattern = """(^\s*\[\s*assembly\s*:\s*((System\s*\.)?\s*Reflection\s*\.)?\s*""" +
                     """AssemblyFileVersion(Attribute)?\s*\(\s*@?\")(([0-9\*])+\.?)+(\"\s*\)\s*\])"""
           replacement = "%system.build.number%"
         }
Content copied to clipboard
    }
}

Constructors

FileContentReplacer

constructor(init: FileContentReplacer.() -> Unit)

constructor()

Types

FileEncoding

enum FileEncoding : Enum<FileContentReplacer.FileEncoding>

File Encoding

RegexMode

enum RegexMode : Enum<FileContentReplacer.RegexMode>

Controls the way the search pattern and the replacement text are interpreted.

Properties

caseSensitivePattern

var caseSensitivePattern: Boolean?

Whether the search should be case-sensitive. Enabled by default. A value of ``false`` sets CASE_INSENSITIVE and UNICODE_CASE flags. Set to ``false`` for case-insensitive languages (e.g. Visual Basic).

customEncodingName

var customEncodingName: String?

A name of the custom encoding to use, works when encoding is set to FileEncoding.CUSTOM

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

encoding

var encoding: FileContentReplacer.FileEncoding?

A file encoding to use

failBuildIfNoFilesMatchPattern

var failBuildIfNoFilesMatchPattern: Boolean?

Enables/disables build failure in case there are no files matching the specified file pattern. Enabled by default.

fileRules

var fileRules: String?

Comma- or newline-separated set of rules in the form of ``+|-:[path relative to the checkout directory]``, wildcards are supported

var id: String?

Build feature id, if not specified will be generated

params

val params: List<Parameter>

pattern

var pattern: String?

Pattern to search for, either in the regular expression (default) or in the fixed strings format, depending on the regexMode.

regexMode

var regexMode: FileContentReplacer.RegexMode?

Controls the way the search pattern and the replacement text are interpreted. The default is RegexMode.REGEX. Set to RegexMode.FIXED_STRINGS to perform a fixed strings search.

replacement

var replacement: String?

Replacement text. In REGEX mode, ``$N`` sequence references ``N``-th capturing group. All backslashes (``\``) and dollar signs (``$``) without a special meaning should be quoted (as ``\\`` and ``\$``, respectively). In REGEX_MIXED and FIXED_STRINGS modes, backslashes (``\``) and dollar signs (``$``) have no special meaning.

type

var type: String

Build feature type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter