Environment variables

Environment variables are pairs of key and value that can be used to customize the build process and store sensitive data such as access details to deployment servers.

Levels

Environment Variables can be defined on 4 levels:

1. Workspace – available for all projects and pipelines. Configured on the dashboard view.
2. Project – available for all pipelines in the project. Configured on the project view.
3. Pipeline – available only for the pipeline in which it was defined. Configured in the Variables tab of the pipeline.
4. Action – available only for the action in which it was defined. Configured in the Variables tab of the action.

Configuration

When adding a new variable, the following fields are available:

• Scope – defines the level of the variable
• Name – the name of the variable, e.g. $SFTP
• Value – the value conveyed by the name, e.g. 192.168.0.100

Additional options let you hide the value of the variable in the logs, and mark the variable as settable, allowing you to change its value and pass it to the next action or pipeline run.

Example usage

Let's configure some variables to encrypt access to an SFTP server:

1. Go to the Variables tab in your deployment pipeline.

2. Add the variables and set your server credentials as values. For example:

   • $SFTP_HOST / 192.168.0.100
   • $SFTP_LOGIN / admin
   • $SFTP_PASS / buddy1234

Variables in pipeline

3. Now you can use the variables to store access credentials to your deployment server:

Storing credentials to deployment server with variables

Supported fields

Environment variables are supported across the whole service, but most commonly used in the build actions. You can predict a variable by entering $ at the beginning of the supported field:

Run commands box

Here's the list of the currently supported fields:

These fields are not available from the front-end. However, the variables do work if the action is added via the REST API or YAML.

Default environment variables

Buddy populates a number of environment variables during each execution, for example, the branch from which you deploy, and the ID of the execution. You can use them in webhooks, notifications, conditional executions, and any place that require passing CI/CD-related information.

Exemplary values

BUDDY=true
BUDDY_WORKSPACE_URL=https://app.buddy.works/myworkspace
BUDDY_WORKSPACE_ID=1
BUDDY_WORKSPACE_NAME=My Workspace
BUDDY_WORKSPACE_DOMAIN=myworkspace
BUDDY_PROJECT_URL=https://app.buddy.works/myworkspace/my-project
BUDDY_PROJECT_NAME=my-project
BUDDY_PROJECT_NAME_ID=my-project
BUDDY_REPO_SLUG=buddyworks/my-project
BUDDY_REPO_SSH_URL=git@github.com:buddyworks/my-project
BUDDY_SCM_URL=https://github.com/buddyworks/my-project
BUDDY_SCM_PROVIDER=GITHUB
BUDDY_PIPELINE_URL=https://app.buddy.works/myworkspace/my-project/pipelines/pipeline/1
BUDDY_PIPELINE_ID=1
BUDDY_PIPELINE_NAME=Deploy to Production
BUDDY_PIPELINE_REF_NAME=master
BUDDY_PIPELINE_TRIGGER_MODE=CLICK
BUDDY_PIPELINE_TARGET_SITE_URL=https://buddy.works/
BUDDY_INVOKER_URL=https://app.buddy.works/myworkspace/profile/1
BUDDY_INVOKER_ID=1
BUDDY_INVOKER_NAME=Mike Benson
BUDDY_INVOKER_EMAIL=mikebenson@buddy.works
BUDDY_INVOKER_AVATAR_URL=https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/05d20f3d58ce09a3b4e9g3334a810603/w/32/32/AVATAR.png
BUDDY_EXECUTION_URL=https://app.buddy.works/myworkspace/my-project/pipelines/pipeline/1/execution/5d9dc42c422f5a268b389d08
BUDDY_EXECUTION_ID=1
BUDDY_EXECUTION_START_DATE=2019-01-01T11:27:40.140Z
BUDDY_EXECUTION_MODE=CLICK
BUDDY_EXECUTION_CLEAR_CACHE=false
BUDDY_EXECUTION_REFRESH=false
BUDDY_EXECUTION_COMMENT=My first execution
BUDDY_EXECUTION_BRANCH=master
BUDDY_EXECUTION_TAG=v1.0
BUDDY_EXECUTION_PULL_REQUEST_ID=pull/1
BUDDY_EXECUTION_PULL_REQUEST_NO=1
BUDDY_EXECUTION_PULL_REQUEST_BASE_BRANCH=master
BUDDY_EXECUTION_PULL_REQUEST_HEAD_BRANCH=master/feature1
BUDDY_EXECUTION_REVISION=e5e13f8b7f8d5c6096a0501dc09b48eef05fea96
BUDDY_EXECUTION_REVISION_URL=https://app.buddy.works/myworkspace/my-project/repository/commit/e5e13f8b7f8d5c6096a0501dc09b48eef05fea96
BUDDY_EXECUTION_REVISION_SHORT=e5e13f8
BUDDY_EXECUTION_REVISION_MESSAGE=Create buddy.yml
BUDDY_EXECUTION_REVISION_SUBJECT=Create buddy.yml
BUDDY_EXECUTION_REVISION_COMMITTER_EMAIL=mikebenson@buddy.works
BUDDY_EXECUTION_REVISION_COMMITTER_NAME=Mike Benson
BUDDY_EXECUTION_CHANGELOG=[e5e13f8] Create buddy.yml | mikebenson | 2019-01-01T07:14:58
BUDDY_FAILED_ACTION_NAME=Upload files

Combining into phrases

Variables can be combined with other words to create longer phrases than can be used, for example, to automatically name your infrastructure, releases, or sandboxes. However, you need to obey the following rules:

• Before the variable: any character is allowed.
• After the variable: letters, numbers, and footers (_) are not allowed.

Correct usage:

release-$BUDDY_EXECUTION_ID-staging
release$BUDDY_EXECUTION_ID:staging
release_$BUDDY_EXECUTION_ID[staging]

Incorrect usage:

release-$BUDDY_EXECUTION_ID_staging (footer)
release-$BUDDY_EXECUTION_IDstaging (letter)
release-$BUDDY_EXECUTION_ID1staging (number)

Passing variables

Actions

Passing variables within one pipeline is useful, e.g. when we want to assign file content to a variable and send it in a notification:

Variable passing pipeline example

Executions

You can pass the values of variables between executions as well. The values can be saved in one execution and then used in another one, e.g. you can set a variable with the version type and increment it in every execution.

Pipelines

You can pass a variable between pipelines using the Run next pipeline action:

1. Go into the Variables tab in the action details.
2. Define the name of the variable and the value to pass: Variables tab

Resetting

To reset settable variables between pipeline executions, you can add an action with a command that will clear the value of the variable (preferably at the beginning or at the end of the pipeline):

export mySettableEnv=
$

Reset variable command

On execution start

You can parameterize your execution using the Pass arguments action - it will pause the pipeline and wait for your input to proceed:

Pass arguments window