Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Commit

Permalink
Added/updated help files.
Browse files Browse the repository at this point in the history
  • Loading branch information
mdjward committed Feb 3, 2015
1 parent c77bd79 commit 79857a5
Show file tree
Hide file tree
Showing 13 changed files with 63 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div>
Indicates whether or not to base the major component of the current version
on the value of an environment variable. Please note that this feature cannot
demote versions; action will only be taken if the component value in the
environment variable at the time of build is <em>higher</em> than the major
component of the current version.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div>
Indicates whether or not to base the minor component of the current version
on the value of an environment variable. Please note that this feature cannot
demote versions; action will only be taken if the component value in the
environment variable at the time of build is <em>higher</em> than the minor
component of the current version.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div>
Name of the environment variable denoting the previous version (before any
updates were applied) to be exported if this feature is enabled.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div>
Enabling this feature will export environment variables globally configured
to denote <strong>previous</strong> and <strong>current</strong> versions
once all version update actions have been completed. These can then be used
by other builders/publishers as appropriate.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<div>
Indicates whether or not the current version should be overriden/reset upon
the next build. <em>Please note, that after use, this option will be
unchecked.</em>
</div>
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<div>
Select which version field to increment upon each build.
Select which version field to increment upon each build. Selecting
"None (skip)" skips this step with no changes applied.
</div>
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<div>
Name of the pre-set environment variable that is responsible for denoting
the current <b>major</b> component of a semantic version number. <i>This
environment variable must be set in order to proceed.</i>
the current <b>major</b> version. If the current version as loaded from the
properties file has a minor version component lower than this, then the minor
version will be upgraded to that provided by the environment variable.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div>
Name of the pre-set environment variable that is responsible for denoting
the current <b>major</b> version. If the current version as loaded from the
properties file has a minor version component lower than this, then the minor
version will be upgraded to that provided by the environment variable.
</div>
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<div>
Name of the pre-set environment variable that is responsible for denoting
the current <b>minor</b> component of a semantic version number. <i>This
environment variable must be set in order to proceed.</i>
the current <b>major</b> version. If the current version as loaded from the
properties file has a major version component lower than this, then the major
version will be upgraded to that provided by the environment variable.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div>
Semantic version number string to reset the current version to in the next
build, regardless of it's current state. As with the checkbox that enables
this feature, this value will be reset after it has been actioned in the
next build.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<div>
Pre-release version string to set (or unset, if selecting "None (clear)") on
the current version. This is useful for indicating nightly builds, release
candidates etc.
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div>
Name of the environment variable denoting the current version (after any
updates have been applied) to be exported if this feature is enabled.
</div>
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<div>
Name of the pre-set environment variable that is responsible for denoting
the current <b>minor</b> component of a semantic version number. This will default
to "0" if not set.
Path to the property file in which the current version is stored. This can
be given as an <strong>absolute path on the filesystem</strong> or a
<strong>relative path to the job's root directory</strong>. Using an absolute
path allows for the sharing of a single properties file between several jobs,
which can be useful for a larger project.
</div>

0 comments on commit 79857a5

Please sign in to comment.