Skip to content
This repository has been archived by the owner on Feb 8, 2023. It is now read-only.

Commit

Permalink
Automatic documentation generated.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nic Patterson committed Mar 21, 2018
1 parent a067c26 commit 6013dda
Show file tree
Hide file tree
Showing 21 changed files with 921 additions and 213 deletions.
12 changes: 12 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,18 @@
</li>







<li class="md-nav__item">
<a href="/VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
12 changes: 12 additions & 0 deletions docs/CHANGELOG/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -584,6 +584,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
12 changes: 12 additions & 0 deletions docs/COMMANDS/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -677,6 +677,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
12 changes: 12 additions & 0 deletions docs/CONTRIBUTING/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
144 changes: 18 additions & 126 deletions docs/GIT/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,40 +436,6 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#getversionmap" title="getVersion(Map)" class="md-nav__link">
getVersion(Map)
</a>

<nav class="md-nav">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#example-1_1" title="Example 1" class="md-nav__link">
Example 1
</a>

</li>

<li class="md-nav__item">
<a href="#example-2_1" title="Example 2" class="md-nav__link">
Example 2
</a>

</li>

<li class="md-nav__item">
<a href="#example-3" title="Example 3" class="md-nav__link">
Example 3
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand All @@ -481,14 +447,14 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#example-1_2" title="Example 1" class="md-nav__link">
<a href="#example-1_1" title="Example 1" class="md-nav__link">
Example 1
</a>

</li>

<li class="md-nav__item">
<a href="#example-2_2" title="Example 2" class="md-nav__link">
<a href="#example-2_1" title="Example 2" class="md-nav__link">
Example 2
</a>

Expand Down Expand Up @@ -558,6 +524,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down Expand Up @@ -649,40 +627,6 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#getversionmap" title="getVersion(Map)" class="md-nav__link">
getVersion(Map)
</a>

<nav class="md-nav">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#example-1_1" title="Example 1" class="md-nav__link">
Example 1
</a>

</li>

<li class="md-nav__item">
<a href="#example-2_1" title="Example 2" class="md-nav__link">
Example 2
</a>

</li>

<li class="md-nav__item">
<a href="#example-3" title="Example 3" class="md-nav__link">
Example 3
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand All @@ -694,14 +638,14 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#example-1_2" title="Example 1" class="md-nav__link">
<a href="#example-1_1" title="Example 1" class="md-nav__link">
Example 1
</a>

</li>

<li class="md-nav__item">
<a href="#example-2_2" title="Example 2" class="md-nav__link">
<a href="#example-2_1" title="Example 2" class="md-nav__link">
Example 2
</a>

Expand Down Expand Up @@ -866,58 +810,6 @@ <h3 id="example-2">Example 2</h3>
// ['host': 'github.example.com', 'owner': 'awesome', 'repo': 'repo']
</code></pre>

<h2 id="getversionmap">getVersion(Map)</h2>
<blockquote>
<p>Determine a version number based on the current latest tag in the repository. Will automatically increment the minor version and append a build version.
You can indicate how to increment the semantic version in your pipelines.yml file:</p>
</blockquote>
<pre><code class="yaml">pipelines:
general:
version:
increment: # all of these nodes can be either a static boolean or a map matching the patterns from tools.git.patterns
major: true
minor:
master: true
feature: false
patch:
master: false
feature: true
</code></pre>

<table>
<thead>
<tr>
<th align="left">Type</th>
<th align="left">Name</th>
<th align="left">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">Map</td>
<td align="left">yml</td>
<td align="left"></td>
</tr>
</tbody>
</table>
<h3 id="example-1_1">Example 1</h3>
<pre><code class="groovy">// Latest tag in the repo is 1.3.1 and it was tagged 5 hours ago
println new com.concur.Git().getVersion(yml)
// 1.4.0-0018000000
</code></pre>

<h3 id="example-2_1">Example 2</h3>
<pre><code class="groovy">// New repo with no tags, repository was created 1 hour ago
println new com.concur.Git().getVersion(yml)
// 0.1.0-0003600000
</code></pre>

<h3 id="example-3">Example 3</h3>
<pre><code class="groovy">// No tags in repo, override default version, created 18 days ago
println new com.concur.Git().getVersion(yml)
// 3.7.0-1555200000
</code></pre>

<h2 id="timesincetagstring">timeSinceTag(String)</h2>
<blockquote>
<p>Get the amount of time since the last Git tag was created.</p>
Expand All @@ -938,13 +830,13 @@ <h2 id="timesincetagstring">timeSinceTag(String)</h2>
</tr>
</tbody>
</table>
<h3 id="example-1_2">Example 1</h3>
<h3 id="example-1_1">Example 1</h3>
<pre><code class="groovy">// Last tag was 3 hours ago
println new com.concur.Git().timeSinceTag('v3.1.0')
// 0010800000 - Padded with 0s on the left.
</code></pre>

<h3 id="example-2_2">Example 2</h3>
<h3 id="example-2_1">Example 2</h3>
<pre><code class="groovy">// last tag was 6 months ago
println new com.concur.Git().timeSinceTag('v0.1.0')
// 1555200000 - Chunked to keep it at 10 characters
Expand Down
12 changes: 12 additions & 0 deletions docs/GITHUBAPI/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
12 changes: 12 additions & 0 deletions docs/HTTP/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
12 changes: 12 additions & 0 deletions docs/SLACK/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
12 changes: 12 additions & 0 deletions docs/STYLE_GUIDE/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,18 @@
</li>







<li class="md-nav__item">
<a href="../VERSIONING/" title="Versioning" class="md-nav__link">
Versioning
</a>
</li>


</ul>
</nav>
</li>
Expand Down
Loading

0 comments on commit 6013dda

Please sign in to comment.