crusade-tracker/system/caches/pluginsDslCache/doc/jetbrains.build-server.configs.kotlin.v10.build-features/-vcs-labeling/index.html

113 lines
6.0 KiB
HTML
Raw Normal View History

2021-01-18 20:27:50 +00:00
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>VcsLabeling - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10.buildFeatures</a>&nbsp;/&nbsp;<a href="./index.html">VcsLabeling</a><br/>
<br/>
<h1>VcsLabeling</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">VcsLabeling</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/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>
<p><strong>See Also</strong><br/>
<p><a href="../vcs-labeling.html">vcsLabeling</a></p>
</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">VcsLabeling</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildFeatures.VcsLabeling$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildFeatures.VcsLabeling, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildFeatures.VcsLabeling)/init">init</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">VcsLabeling</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildFeatures.VcsLabeling$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildFeatures.VcsLabeling, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildFeatures.VcsLabeling)/base">base</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">VcsLabeling</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="branch-filter.html">branchFilter</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">branchFilter</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><a href="https://www.jetbrains.com/help/teamcity/?Configuring+VCS+Triggers#ConfiguringVCSTriggers-BranchFilter">Branch filter</a> specifies
in which branches sources should be labeled</p>
</td>
</tr>
<tr>
<td>
<p><a href="labeling-pattern.html">labelingPattern</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">labelingPattern</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>A pattern for labels to use. If not specified, then the default pattern is used: build-%system.build.number%.</p>
</td>
</tr>
<tr>
<td>
<p><a href="successful-only.html">successfulOnly</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">successfulOnly</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">?</span></code>
<p>Whether only successful builds sources should be labeled</p>
</td>
</tr>
<tr>
<td>
<p><a href="vcs-root-ext-id.html">vcsRootExtId</a></p>
</td>
<td>
<code><span class="keyword">var </span><s><span class="identifier">vcsRootExtId</span></s><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>Id of the VCS root which sources should be labeled. Use the constant "<strong>ALL</strong>" to label all VCS roots.</p>
</td>
</tr>
<tr>
<td>
<p><a href="vcs-root-id.html">vcsRootId</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">vcsRootId</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>Id of the VCS root which sources should be labeled. Use the constant "<strong>ALL</strong>" to label all VCS roots.</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/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="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/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="../../jetbrains.build-server.configs.kotlin.v10/-build-feature/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>
</BODY>
</HTML>