Help documentation

Use current revision in a build

It is often useful to use the current version control revision number in your build. For example, you might want to use the svn version number in the name of your binary for tracing purposes. Cruise makes much of this information available to your build scripts as environment variables.

Example usages

One material

Multiple materials

All Cruise environment variables

Environment Variable Description Example contents
CRUISE_SERVER_URL Base URL for the Cruise server (including the context root)
https://127.0.0.1:8154/cruise
CRUISE_PIPELINE_NAME Name of the current pipeline being run
cruise
CRUISE_PIPELINE_LABEL Label for the current pipeline. By default, this is set to the pipeline count (this can be set to a custom pipeline label)
1.1.2345
CRUISE_STAGE_NAME Name of the current stage being run
dev
CRUISE_STAGE_COUNTER How many times the current stage has been run
1
CRUISE_JOB_NAME Name of the current job being run
linux-firefox
CRUISE_DEPENDENCY_LABEL_ ${pipeline name}_${stage name} The label of the upstream pipeline (when using dependant pipelines)
1.0.3456
CRUISE_REVISION The current source control revision being run (when using only one material
123
CRUISE_REVISION_ ${material dest} If you are using more than one material in your pipeline the revision for each material is available. The environment variable is names with the material's "dest" directory. Non alphanumeric characters are replaced with underscores("_").
456