Automation Environment Variables

In your automation script, you have access to a number of Automation environment variables. Use these variables to get data about your execution context: current Git branch name and Git revision number, Space URL, and so on.

Unlike regular container environment variables, you can get Automation variables using the API commands (only inside the kotlinScript block):

        job("Example") {
            container(displayName = "Show keys", image = "openjdk:11.0.3-jdk") {
                kotlinScript { api ->
                    println("Project key: " + System.getenv("JB_SPACE_PROJECT_KEY"))
                    println("Project key: " + api.projectKey())
                }
            }
        }
    

When does Automation resolve environment variables

The work of an Automation script consists of two phases:

Script compilation: Automation checks the .space.kts file for errors and compiles the necessary script parts. This phase is performed in a separate container that cannot be anyhow accessed from within the script. Automation environment variables are not resolved on this phase.
Script run: Automation runs the content of kotlinScript, shellScript, and docker.beforeBuildScript in a container. On this phase, Automation environment variables are resolved inside the specified container. This means that you can access Automation environment variables only inside the kotlinScript, shellScript, and beforeBuildScript items.

General

Variable	API method	Description
`JB_SPACE_API_URL`	`spaceUrl(): String`	The URL of your JetBrains Space instance. For example: mycompany.jetbrains.space

Authentication

Variable	API method	Description
`JB_SPACE_CLIENT_ID` `JB_SPACE_CLIENT_SECRET`	`spaceClientId(): String` `spaceClientSecret(): String`	Temporary OAuth 2.0 credentials issued to the current script. The script uses them to authenticate in various Space modules. For example, you may need them to authenticate in a Packages repository in order to publish script artifacts.

Project settings

Variable	API method	Description
`JB_SPACE_GIT_REVISION`	`gitRevision(): String`	The current Git revision number
`JB_SPACE_GIT_BRANCH`	`gitBranch(): String`	The current Git branch name
`JB_SPACE_PROJECT_ID`	`projectId(): String`	The ID of the current project
`JB_SPACE_PROJECT_KEY`	`projectKey(): String`	The key of the current project
`JB_SPACE_GIT_REPOSITORY_NAME`	`gitRepositoryName(): String`	The name of the current Git repository (the one that contains the currently running `.space.kts` file)

Automation

Variable	API method	Description
`JB_SPACE_EXECUTION_NUMBER`	`executionNumber(): String`	The current build number. For example, you can use it to generate application version number. Learn more

Example. Use environment variables to generate a product version

For example, you want to generate a Docker container tag based on the current branch name and the job run number like version-0.123-mybranch:

            job("Build and push image") {
                docker {
                    beforeBuildScript {
                        // Create an env variable BRANCH,
                        // use env var to get full branch name,
                        // leave only the branch name without the 'refs/heads/' path
                        content = """
                            export BRANCH=${'$'}(echo ${'$'}JB_SPACE_GIT_BRANCH | cut -d'/' -f 3)
                        """
                    }
                    build {
                        context = "docker"
                        file = "./docker/Dockerfile"
                    }

                    push("mycompany.registry.jetbrains.space/p/pkey/mydocker/myimage") {
                        // Use the BRANCH and JB_SPACE_EXECUTION_NUMBER env vars
                        tag = "version-0.\$JB_SPACE_EXECUTION_NUMBER-\$BRANCH"
                    }
                }
            }
        

Last modified: 15 March 2021