version resource is used to store semantic version numbers.
You can create a
version resource by adding it to
resources: - name: <string> type: version seed: <object>
name-- should be an easy to remember text string
type-- is set to
seed-- is an object which contains specific properties that applies to this resource.
seed: versionName: "0.0.1"
versionNameis a string that represents a semantic version that is used as a starting point when used with a release job. You can also also use
Used in Jobs
This resource is used as an
IN for the following jobs:
Default Environment Variables
version is used as an
OUT for a
runCI job, a set of environment variables is automatically made available that you can use in your scripts.
<NAME> is the the friendly name of the resource with all letters capitalized and all characters that are not letters, numbers or underscores removed. For example,
my-key-1 will be converted to
my_key_1 will be converted to
||The name of the resource.|
||The ID of the resource.|
||The type of the resource. In this case
||The operation of the resource; either
||The directory containing files for the resource.|
||VersionName defined in the seed section.|
||SourceName defined in the pointer.|
||The ID of the version of the resource being used.|
||versionName of the version of the resource being used.|
||The number of the version of the resource being used.|
Shippable Utility Functions
To make it easy to use these environment variables, the platform provides a command line utility that can be used to work with these values.
How to use these utility functions is documented here.