[JENKINS-48523] help file for buildingTag

jenkinsci · Jan 19, 2018 · 0cda9ac · 0cda9ac
1 parent 5881859
commit 0cda9ac
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 1 deletion.
diff --git a/...org/jenkinsci/plugins/pipeline/modeldefinition/when/impl/BuildingTagConditional/help.html b/...org/jenkinsci/plugins/pipeline/modeldefinition/when/impl/BuildingTagConditional/help.html
@@ -0,0 +1,30 @@
+<!--
+  ~ The MIT License
+  ~
+  ~ Copyright (c) 2018, CloudBees, Inc.
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in
+  ~ all copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  ~ THE SOFTWARE.
+  ~
+  -->
+
+<p>
+    Execute the stage if the <code>TAG_NAME</code> variable exists, i.e. the build is building a tag.
+    Same as if using <code>tag</code> with an empty pattern.
+    Only works in Multibranch.
+</p>
diff --git a/...sources/org/jenkinsci/plugins/pipeline/modeldefinition/when/impl/TagConditional/help.html b/...sources/org/jenkinsci/plugins/pipeline/modeldefinition/when/impl/TagConditional/help.html
@@ -24,6 +24,6 @@
   -->
 <p>
     Execute the stage if the <code>TAG_NAME</code> variable matches the given <a href="https://ant.apache.org/manual/dirtasks.html#patterns">ANT style pattern</a>.
-    If no pattern is provided the stage will execute if the <code>TAG_NAME</code> variable exists.
+    If an empty pattern is provided the stage will execute if the <code>TAG_NAME</code> variable exists.
     Only works in Multibranch.
 </p>