Skip to content

artifactPrepareVersion

Prepares and potentially updates the artifact's version before building the artifact.

Description

Prepares and potentially updates the artifact's version before building the artifact.

The continuous delivery process requires that each build is done with a unique version number. There are two common patterns found:

1. Continuous Deployment pattern with automatic versioning

The team has full authority on <major>.<minor>.<patch> and can increase any part whenever required. Nonetheless, the automatic versioning makes sure that every build will create a unique version by appending <major>.<minor>.<patch> with a buildversion (we use a timestamp) and optinally the commitId.

In order to represent this version also in the version control system the new unique version will be pushed with a dedicated tag (<tagPrefix><major>.<minor>.<patch><unique extension>).

Depending on the build tool used and thus the allowed versioning format the <unique extension> varies.

Remarks:

  • There is no commit to master since this would create a perpetuum mobile and just trigger the next automatic build with automatic versioning, and so on ...
  • Not creating a tag would lead to a loss of the final artifact version in scm which often is not acceptable
  • You need to ensure that your CI/CD system can push back to your SCM (via providing ssh or HTTP(s) credentials)

This pattern is the default behavior (versioningType: cloud) since this is suitable for most cloud deliveries.

It is possible to use versioningType: cloud_noTag which has a slighly different behavior than described above:

  • The new version will NOT be written as tag into the SCM but it is only available in the corresponding CI/CD workspace
  • IMPORTANT NOTICE: Using the option cloud_noTag should not be picked in case you need to ensure a fully traceable path from SCM commit to your build artifact.

2. Pure version <major>.<minor>.<patch>

This pattern is often used by teams that have cloud deliveries with no fully automated procedure, e.g. delivery after each takt. Another typical use-case is development of a library with regular releases where the versioning pattern should be consumable and thus ideally complies to a <major>.<minor>.<patch> pattern.

The version is then either manually set by the team in the course of the development process or automatically pushed to master after a successful release.

Unlike for the Continuous Deloyment pattern descibed above, in this case there is no dedicated tagging required for the build process since the version is already available in the repository.

Configuration of this pattern is done via versioningType: library.

Support of additional build tools

Besides the buildTools provided out of the box (like maven, mta, npm, ...) it is possible to set buildTool: custom.

This allows you to provide automatic versioning for tools using a:

file with the version as only content:

Define buildTool: custom as well as filePath: <path to your file>

Please note: <path to your file> need to point either to a *.txt file or to a file without extension.

ini file containing the version:

Define buildTool: custom, filePath: <path to your ini-file> as well as parameters versionSection and versionSource to point to the version location (section & parameter name) within the file.

Please note: <path to your file> need to point either to a *.cfg or a *.ini file.

json file containing the version:

Define buildTool: custom, filePath: <path to your *.json file as well as parameter versionSource to point to the parameter containing the version.

yaml file containing the version

Define buildTool: custom, filePath: <path to your *.yml/*.yaml file as well as parameter versionSource to point to the parameter containing the version.

Usage

We recommend to define values of step parameters via config.yml file. In this case, calling the step is reduced to one simple line.
Calling the step can be done either via the Jenkins library step or on the command line.

Jenkins pipelines

artifactPrepareVersion script: this

Command line

piper artifactPrepareVersion

Outputs

Output type Details
commonPipelineEnvironment
  • artifactVersion
  • originalArtifactVersion
  • git/commitId
  • git/commitMessage

Parameters

Overview

Name Mandatory Additional information
buildTool yes
script yes Jenkins only reference to Jenkins main pipeline script
commitUserName no
containerCommand no Jenkins only
containerShell no Jenkins only
customVersionField no
customVersionSection no
customVersioningScheme no
dockerEnvVars no Jenkins only
dockerImage no Jenkins only
dockerName no Jenkins only
dockerOptions no Jenkins only
dockerPullImage no Jenkins only
dockerVersionSource no
dockerVolumeBind no Jenkins only
dockerWorkspace no Jenkins only
filePath no
globalSettingsFile no
includeCommitId no
m2Path no
password no Secret pass via ENV or Jenkins credentials (gitHttpsCredentialsId)
projectSettingsFile no
shortCommitId no
tagPrefix no
unixTimestamp no
username no Secret pass via ENV or Jenkins credentials (gitHttpsCredentialsId)
verbose no activates debug output
versioningTemplate no
versioningType no

Details

buildTool

Defines the tool which is used for building the artifact. Supports custom, dub, golang, maven, mta, npm, pip, sbt.

back to overview

Scope Details
Aliases -
Type string
Mandatory yes
Default $PIPER_buildTool (if set)
Possible values - custom
- docker
- dub
- golang
- maven
- mta
- npm
- pip
- sbt
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

commitUserName

Defines the user name which appears in version control for the versioning update (in case versioningType: cloud).

back to overview

Scope Details
Aliases gitUserName
Type string
Mandatory no
Default Project Piper
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

containerCommand

Jenkins-specific: Used for proper environment setup.

Kubernetes only: Allows to specify start command for container created with dockerImage parameter to overwrite Piper default (/usr/bin/tail -f /dev/null).

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

containerShell

Jenkins-specific: Used for proper environment setup.

Allows to specify the shell to be executed for container with containerName.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

customVersionField

For buildTool: custom: Defines the field which contains the version in the descriptor file.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_customVersionField (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

customVersionSection

For buildTool: custom: Defines the section for version retrieval in vase a .ini/.cfg file is used.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_customVersionSection (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

customVersioningScheme

For buildTool: custom: Defines the versioning scheme to be used (possible options pep440, maven, semver2).

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_customVersioningScheme (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerEnvVars

Jenkins-specific: Used for proper environment setup.

Environment variables to set in the container, e.g. [http_proxy: "proxy:8080"].

back to overview

Scope Details
Aliases -
Type map[string]string
Mandatory no
Default
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerImage

Jenkins-specific: Used for proper environment setup.

Name of the docker image that should be used. If empty, Docker is not used and the command is executed directly on the Jenkins system.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default buildTool=maven: maven:3.6-jdk-8
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerName

Jenkins-specific: Used for proper environment setup.

Kubernetes only: Name of the container launching dockerImage. SideCar only: Name of the container in local network.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerOptions

Jenkins-specific: Used for proper environment setup.

Docker options to be set when starting the container.

back to overview

Scope Details
Aliases -
Type []string
Mandatory no
Default
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerPullImage

Jenkins-specific: Used for proper environment setup.

Set this to 'false' to bypass a docker image pull. Usefull during development process. Allows testing of images which are available in the local registry only.

back to overview

Scope Details
Aliases -
Type bool
Mandatory no
Default buildTool=maven: false
Possible values - true
- false
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerVersionSource

For buildTool: docker: Defines the source of the version. Can be FROM, any supported buildTool or an environment variable name.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_dockerVersionSource (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerVolumeBind

Jenkins-specific: Used for proper environment setup.

Volumes that should be mounted into the docker container.

back to overview

Scope Details
Aliases -
Type map[string]string
Mandatory no
Default
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

dockerWorkspace

Jenkins-specific: Used for proper environment setup.

Kubernetes only: Specifies a dedicated user home directory for the container which will be passed as value for environment variable HOME.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

filePath

Defines a custom path to the descriptor file. Build tool specific defaults are used (e.g. maven: pom.xml, npm: package.json, mta: mta.yaml).

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_filePath (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

globalSettingsFile

Maven only - Path to the mvn settings file that should be used as global settings file.

back to overview

Scope Details
Aliases maven/globalSettingsFile
Type string
Mandatory no
Default $PIPER_globalSettingsFile (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

includeCommitId

Defines if the automatically generated version (versioningType: cloud) should include the commit id hash.

back to overview

Scope Details
Aliases -
Type bool
Mandatory no
Default true
Possible values - true
- false
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

m2Path

Maven only - Path to the location of the local repository that should be used.

back to overview

Scope Details
Aliases maven/m2Path
Type string
Mandatory no
Default $PIPER_m2Path (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

password

Password/token for git authentication.

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_password (if set)
Secret yes
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references Jenkins credential id:
  id: gitHttpsCredentialsId
  reference to: password

projectSettingsFile

Maven only - Path to the mvn settings file that should be used as project settings file.

back to overview

Scope Details
Aliases maven/projectSettingsFile
Type string
Mandatory no
Default $PIPER_projectSettingsFile (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

script

Jenkins-specific: Used for proper environment setup.

The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.

back to overview

Scope Details
Aliases -
Type Jenkins Script
Mandatory yes
Default
Secret no
Configuration scope
  • ☐ parameter
  • ☐ general
  • ☐ steps
  • ☐ stages
Resource references none

shortCommitId

Defines if a short version of the commitId should be used. GitHub format is used (first 7 characters).

back to overview

Scope Details
Aliases -
Type bool
Mandatory no
Default false
Possible values - true
- false
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

tagPrefix

Defines the prefix which is used for the git tag which is written during the versioning run (only versioningType: cloud).

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default build_
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

unixTimestamp

Defines if the Unix timestamp number should be used as build number instead of the standard date format.

back to overview

Scope Details
Aliases -
Type bool
Mandatory no
Default false
Possible values - true
- false
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

username

User name for git authentication

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_username (if set)
Secret yes
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references Jenkins credential id:
  id: gitHttpsCredentialsId
  reference to: username

verbose

verbose output

back to overview

Scope Details
Aliases -
Type bool
Mandatory no
Default false
Possible values - true
- false
Secret no
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages
Resource references none

versioningTemplate

DEPRECATED: Defines the template for the automatic version which will be created

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_versioningTemplate (if set)
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

versioningType

Defines the type of versioning (cloud: fully automatic, cloud_noTag: automatic but no tag created, library: manual, i.e. the pipeline will pick up the version from the build descriptor, but not generate a new version)

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default cloud
Possible values - cloud
- cloud_noTag
- library
Secret no
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references none

gitHttpsCredentialsId

Jenkins-specific: Used for proper environment setup.

back to overview

Scope Details
Aliases -
Type string
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages

gitSshKeyCredentialsId

Jenkins-specific: Used for proper environment setup.

back to overview

Scope Details
Aliases gitCredentialsId (deprecated)
Type string
Configuration scope
  • ☒ parameter
  • ☒ general
  • ☒ steps
  • ☒ stages