Automation Environment Variables

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

If you want to get environment variables in a shell script, note that you need to escape the $ symbol in a Kotlin way, for example, ${'$'}JB_SPACE_API_URL. Also, you can get some of the Automation environment variables using the the API commands (only inside the kotlinScript block). For example:

        job("Example") {
            container(displayName = "Show key using shell", image = "ubuntu:latest") {
                shellScript {
                    content = """
                        echo Project key: ${'$'}JB_SPACE_PROJECT_KEY
                    """
                }
            }

            container(displayName = "Show key using api", image = "openjdk:11.0.3-jdk") {
                kotlinScript { api ->
                    // get env var from system
                    println("Project key: " + System.getenv("JB_SPACE_PROJECT_KEY"))
                    // get env var using API
                    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. On this phase, Automation environment variables are resolved inside the specified run environment. This means that you can access Automation environment variables only inside the kotlinScript, shellScript, and beforeBuildScript blocks.

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_TOKEN`	`spaceClientToken(): String`	Temporary OAuth 2.0 access token issued to the current script. The script can use it to authorize in various Space modules. For example, you can use it to authorize the script in a Packages repository in order to publish build artifacts.
`JB_SPACE_CLIENT_ID`, `JB_SPACE_CLIENT_SECRET`	`spaceClientId(): String`, `spaceClientSecret(): String`	As an alternative to an access token, the script can authorize with temporary OAuth 2.0 credentials.

Project settings

Variable	API method	Description
`JB_SPACE_STEP_DATA_PATH`	–	An absolute path to the parent directory with the step data.
`JB_SPACE_WORK_DIR_PATH`	–	An absolute path to the project working directory. Learn more about directory structure in containers and hosted workers.
`JB_SPACE_FILE_SHARE_PATH`	–	An absolute path to the external storage used for file sharing.
`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(): Int`	The current job execution number (build number). For example, you can use it to generate application version number. Learn more
`JB_SPACE_EXECUTION_ID`	`executionId(): String`	The unique ID of the current job execution (build). You can use it to refer to a particular build using the Space API.
`JB_SPACE_EXECUTION_URL`	`executionUrl(): String`	A link to the current job execution.

Self-hosted and cloud workers

Variable	API method	Description
`SPACE_WORKER_SERVERURL`	–	The URL of the JetBrains Space instance assigned to the worker. For example: mycompany.jetbrains.space
`SPACE_WORKER_TOKEN`	–	An authorization token issued to the worker. The worker uses it to authenticate in Space.
`SPACE_WORKER_DATADIR`	–	The path to the directory where the script downloads all required data: project sources, file share, and Automation-specific data.
`SPACE_WORKER_HOSTNAME`	–	A host name of the worker.
`SPACE_WORKER_CPU`, `SPACE_WORKER_MEM`	–	The system resources available on the host machine that runs the worker agent: CPU cores in mCPU, and RAM in MB.

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: 29 September 2022