286 lines
20 KiB
HTML
286 lines
20 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<meta charset="UTF-8">
|
|
<title>BuildFeature - </title>
|
|
<link rel="stylesheet" href="../../style.css">
|
|
</HEAD>
|
|
<BODY>
|
|
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10</a> / <a href="./index.html">BuildFeature</a><br/>
|
|
<br/>
|
|
<h1>BuildFeature</h1>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">BuildFeature</span> <span class="symbol">:</span> <a href="../-parametrized/index.html"><span class="identifier">Parametrized</span></a></code>
|
|
<p>Represents TeamCity <a href="https://www.jetbrains.com/help/teamcity/?Adding+Build+Features">build feature</a></p>
|
|
<h3>Constructors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="-init-.html"><init></a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="identifier">BuildFeature</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.BuildFeature$<init>(jetbrains.buildServer.configs.kotlin.v10.BuildFeature, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.BuildFeature, kotlin.Unit)))/base">base</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.BuildFeature$<init>(jetbrains.buildServer.configs.kotlin.v10.BuildFeature, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.BuildFeature, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a> <span class="symbol">=</span> {}<span class="symbol">)</span></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="enabled.html">enabled</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">enabled</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
|
|
<p>Specifies whether the feature is enabled</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="id.html">id</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">id</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
|
|
<p>Build feature id, if not specified will be generated</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="type.html">type</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
|
|
<p>Build feature type</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Properties</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/params.html">params</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">params</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../-parameter/index.html"><span class="identifier">Parameter</span></a><span class="symbol">></span></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inherited Functions</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/boolean-parameter.html">booleanParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">booleanParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/trueValue">trueValue</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> "true"<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$booleanParameter(kotlin.String, kotlin.String, kotlin.String)/falseValue">falseValue</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> "false"<span class="symbol">)</span><span class="symbol">: </span><a href="../-boolean-delegate/index.html"><span class="identifier">BooleanDelegate</span></a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/compound-parameter.html">compoundParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../-compound-param/index.html"><span class="identifier">CompoundParam</span></a><span class="symbol">></span> <span class="identifier">compoundParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$compoundParameter(kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-compound-param-delegate/index.html"><span class="identifier">CompoundParamDelegate</span></a><span class="symbol"><</span><a href="../-parametrized/compound-parameter.html#T"><span class="identifier">T</span></a><span class="symbol">></span></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/enum-parameter.html">enumParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">E</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html"><span class="identifier">Enum</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">></span><span class="symbol">></span> <span class="identifier">enumParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$enumParameter(kotlin.String, kotlin.collections.Map((jetbrains.buildServer.configs.kotlin.v10.Parametrized.enumParameter.E, kotlin.String)))/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$enumParameter(kotlin.String, kotlin.collections.Map((jetbrains.buildServer.configs.kotlin.v10.Parametrized.enumParameter.E, kotlin.String)))/mapping">mapping</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">,</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span><span class="symbol">></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-enum-delegate/index.html"><span class="identifier">EnumDelegate</span></a><span class="symbol"><</span><a href="../-parametrized/enum-parameter.html#E"><span class="identifier">E</span></a><span class="symbol">></span></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/int-parameter.html">intParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">intParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$intParameter(kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-int-delegate/index.html"><span class="identifier">IntDelegate</span></a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/param.html">param</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">param</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$param(kotlin.String, kotlin.String)/name">name</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$param(kotlin.String, kotlin.String)/value">value</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
|
|
<p>Adds parameter</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-parametrized/string-parameter.html">stringParameter</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">fun </span><span class="identifier">stringParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.Parametrized$stringParameter(kotlin.String)/customName">customName</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="../-string-delegate/index.html"><span class="identifier">StringDelegate</span></a></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3>Inheritors</h3>
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-auto-merge/index.html">AutoMerge</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">AutoMerge</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>Build feature enabling <a href="https://www.jetbrains.com/help/teamcity/?Automatic+Merge">automatic merge</a>
|
|
in build configuration or template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-commit-status-publisher/index.html">CommitStatusPublisher</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">CommitStatusPublisher</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?Commit+Status+Publisher">build feature</a> publishing
|
|
status to external system</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-docker-support-feature/index.html">DockerSupportFeature</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">DockerSupportFeature</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p><a href="https://www.jetbrains.com/help/teamcity/?Docker+Support">Docker Support feature</a>
|
|
tracks pushed images and adds a dedicated tab with information about them.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../-failure-condition/index.html">FailureCondition</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">FailureCondition</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>TeamCity <a href="https://www.jetbrains.com/help/teamcity/?Build+Failure+Conditions">failure condition</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-file-content-replacer/index.html">FileContentReplacer</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">FileContentReplacer</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?File+Content+Replacer">build feature</a> which processes text files by performing regular expressions</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-free-disk-space/index.html">FreeDiskSpace</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">FreeDiskSpace</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>Build feature ensuring certain <a href="https://www.jetbrains.com/help/teamcity/?Free+disk+space">free disk space</a>
|
|
on the agent before the build by deleting files managed by the TeamCity agent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-golang-feature/index.html">GolangFeature</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">GolangFeature</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p><a href="https://www.jetbrains.com/help/teamcity/golang.html">Golang feature</a>
|
|
processing Golang tests</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-investigations-auto-assigner/index.html">InvestigationsAutoAssigner</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">InvestigationsAutoAssigner</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://github.com/JetBrains/teamcity-investigations-auto-assigner">build feature</a> assigning
|
|
investigations of build failures automatically based on heuristics</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-jira-cloud-integration/index.html">JiraCloudIntegration</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">JiraCloudIntegration</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A build feature enabling integration with Jira Cloud via its Build and Deployment APIs</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-notifications/index.html">Notifications</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Notifications</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>Build feature for notification rule</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-nu-get-feed-credentials/index.html">NuGetFeedCredentials</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">NuGetFeedCredentials</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://confluence.jetbrains.com/display/TCDL/NuGet+Feed+Credentials">build feature</a> to provide feed credentials.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-nu-get-packages-indexer/index.html">NuGetPackagesIndexer</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">NuGetPackagesIndexer</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://confluence.jetbrains.com/display/TCDL/NuGet">build feature</a> to index *.nupkg files in
|
|
build artifacts into TeamCity NuGet Feed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-perfmon/index.html">Perfmon</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Perfmon</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://confluence.jetbrains.com/display/TCDL/Performance+Monitor">build feature</a> allows you to get the statistics on the CPU, disk and memory usage during a build run on a build agent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-pull-requests/index.html">PullRequests</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">PullRequests</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?Pull+Requests">build feature</a> that introduces GitHub pull requests integration</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-ssh-agent/index.html">SshAgent</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">SshAgent</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?SSH+Agent">build feature</a> which runs
|
|
SSH agent during a build with the specified SSH key loaded</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-swabra/index.html">Swabra</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Swabra</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>A <a href="https://www.jetbrains.com/help/teamcity/?Build+Files+Cleaner+(Swabra)">build feature</a> cleaning files and processes created during a build</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p><a href="../../jetbrains.build-server.configs.kotlin.v10.build-features/-vcs-labeling/index.html">VcsLabeling</a></p>
|
|
</td>
|
|
<td>
|
|
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">VcsLabeling</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">BuildFeature</span></a></code>
|
|
<p>Build feature enabling <a href="https://www.jetbrains.com/help/teamcity/?VCS+Labeling#VCSLabeling-AutomaticVCSlabeling">automatic VCS labeling</a> in a build.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</BODY>
|
|
</HTML>
|