Environment variables
Environment variables are pairs of key-and-value that can be used in the pipelines instead of manually updating the same values. They allow developers to save time looking up and entering access details, and eliminate the risk of providing sensitive details in their scripts.
ENV VARs are used to parameterize build scripts. Setting up variables in a pipeline will cause the same build action to work differently depending on the pipeline.
Setting Environment Variables
When adding a new variable, the following fields are available:
- Scope - defines the level of the variable
- Encryption - enabling encryption will hide the value of the variable in the logs
- Type - if you set it to Fixed, the value of the variable will always be the same. Switching the option to Settable will let you change the value and pass it to the next action or execution
Environment Variables can be defined on 4 levels:
- Workspace - available for all projects and pipelines. Configured in the workspace Preferences.
- Project - available for all pipelines in the project. Configured in the Project Options.
- Pipeline - available only for the pipeline where was created (eg. production server details). Configured in the pipeline details.
- Action - available only for the actions where the variable was defined
Each subsequent tier will overwrite the value from the higher tier. For example, if you have two same variables - one defined on the workspace level and another on the pipeline level - Buddy will use the pipeline value in that pipeline, and the workspace value in the rest of the account.
Example Usage
Let's configure some variables to encrypt access to an FTP server:
- Go to your deployment pipeline and click the Variables tab
- Add variables with the corresponding values. For example:
- Hostname:
FTP_HOST/192.168.0.100 - Login:
FTP_LOGIN/admin - Password:
FTP_PASS/buddy1234
- Hostname:
- Now you can use the variables to store access credentials to your deployment server:
Fields that support ENV VARs
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:
Here's the list of the currently supported fields:
| Action Name | Supported Fields |
|---|---|
| Amazon S3 | SourcePath, Remote Path, Tag Objects Value |
| AWS CLI | Run Commands |
| AWS CLI 2 | Run Commands |
| AWS ECS | Source Path |
| AWS Lambda Deploy | Source Path |
| AWS Lambda Trigger | Payload |
| Azure App Service | URL, Login, Password |
| Azure CLI | Run Commands |
| Azure Storage | Source Path, Remote Path |
| Build Android App | Run Commands, Mount Filesystem Path, Mount Container Path, Working dir |
| Build Android React Native Application | Run Commands, Mount Filesystem Path, Mount Container Path, Working dir |
| Build Docker Image | Name, Value |
| Build Flutter App | Run Commands, Mount Filesystem Path, Mount Container Path, Working dir |
| Build Ionic app | Mount Filesystem Path, Mount Container Path, Working dir |
| Bugsnag | API Key, Version, Revision, Builder Name, Release Stage |
| CloudFront | Base URL, Source Path |
| Cloudflare | Base URL |
| CodeDeploy | Source Path, Bucke tName, Description |
| Compress images | Source Path, Destination Path |
| Copy files | Source Path, Remote Path |
| Custom Build | Mount Filesystem Path, Mount Container Path, Working dir |
| Datadog | Event Title, Content, Host, Tags, Aggregation Key |
| Datadog Service Check | Hostname, Check |
| DigitalOcean Droplet | Source Path, Port, Login, Password, Remote Path, SSH Key Passphrase |
| DigitalOcean Spaces | SourcePath, Remote Path |
| DigitalOcean Spaces CDN | BaseURL |
| Discord | Channel, Attachments, Message |
| Dockerfile | Build Arguments |
| Dockerfile Linter | Dockerfile, YAML file with ignores |
| Elastic Beanstalk | Source, Version, Bucket 1, Environment 2 |
| Subject, Attachments, Message | |
| Eslint | Mount Filesystem Path, Mount Container Path, Working dir |
| Find & replace | Source Path, Replacements |
| Firebase | Mount Filesystem Path, Mount Container Path, Working dir |
| FTP | Source Path, Hostname, Port, Login, Password, RemotePath |
| FTP Download | SFTP Download |
| FTPS | Source Path, Hostname, Port, Login, Password, Remote Path |
| Function Deploy | |
| GCE | Source Path, Hostname, Port, Login, Password, Remote Path |
| GCloud CLI | Run Commands |
| GCS | SourcePath, RemotePath |
| Ghost Inspector | Path |
| Git Push | URL, Login, Password |
| Gitcrypt lock | |
| Gitcrypt unlock | |
| Github Release | Tag Name, Target Commitish, Release Name, Release Description, Source Path, Asset Label |
| Google App Engine | Source Path, Bucket, Version, ImageURL |
| Google CDN | BaseURL |
| Google Cloud CLI | Run Commands |
| Google Cloud Functions | Source Path |
| Google Cloud Storage | Source Path, Remote Path |
| Google Compute Engine | Source Path, Hostname, Port, Login, Password, Remote Path |
| Google Function Trigger | |
| Heroku | |
| Heroku CLI | Run Commands |
| Honeybadger | Environment |
| HTTP | EndpointURL, Login, Password, Request headers |
| Image compression | Source, Destination |
| Kubernetes Apply | Server, Username, Password, Source Path, Prune Whitelist, Grace Period |
| Kubernetes CLI | Server, Username, Password, Run Commands |
| Run Kubernetes Job | Server, Username, Password, Yaml |
| Run Kubernetes Pod | Server, Username, Password, Yaml |
| Set Kubernetes Image | Server, Username, Password, ImageName, Image Tag |
| Lambda Deploy | SourcePath |
| Lambda Trigger | Qualifier |
| Link validator | URL |
| Lighthouse | URL |
| Local Shell | |
| Loggly | Tags |
| Monitoring | Environment 3, Application 4 |
| MS Teams | Channel email, Title, Attachments from filesystem |
| Netlify | |
| New Relic | Description, Changelog, Version |
| Pass arguments | |
| PHP CodeSniffer | Mount Filesystem Path, Mount Container Path, Working dir |
| Ping | Host |
| Publish APK to Google Play | APK, Main expansion file, Patch expansion file, Service Key, Package name, Mapping file |
| Pushbullet | Title, URL, Message |
| Push Docker Image | Login, Password, Repository, Tags |
| Pushover | Title, URL, URL Title, Message |
| Rackspace | Source Path, Remote Path |
| Raygun | Access Token, API Key, Version, User, Email, Comment |
| Replace | Source Path, Replacements (name) |
| Rollbar | Environment, Comment, Username, Rollbar Username |
| Rsync | Source Path, Hostname, Port, Login, Password, Remote Path |
| Run Docker Image | Login, Password, Image, Version |
| Run Helm CMDs | Run Commands, Server, Username, Password |
| Run next pipeline | Comment |
| Sentry | Release Version, Deploy Environment, Release URL, Deploy URL, Repository |
| Sentry On-premises | Release Version, Deploy Environment, Release URL, Deploy URL, Repository |
| Sign APK | Select the APK, Location, Keystore Password, Key Alias, Output Directory, Output APK Name |
| SFTP | SourcePath, Hostname, Port, Login, Password, Remote Path |
| SFTP Download | Hostname, Port, Login, Password, Source Path, Destination Path |
| Shopify | SourcePath |
| Slack | Attachments, Message |
| Sleep | |
| SMS | Message |
| S3 Download | Source Path, Destination |
| Split tests | Tests Path |
| SSH | Source Path, Hostname, Port, Login, Password, RemotePath |
| SSL verify | Website URL |
| TCP | Host, Port, String To Send, String To Expect |
| Theme Kit Cli | Run Commands |
| Telegram | Attachments, Message |
| Upcloud | Source Path, Port, Login, Password, RemotePath, SSH Key Passphrase |
| Visual tests | |
| Vultr | SourcePath, Port, Login, Password, Remote Path |
| Wait for approval | Question |
| WEB | URL, Check For String, Login, Password, Request headers |
| WebDAV | Source Path, Hostname, Login, Password |
| ZIP | Source Path, Target Path, File Name |
Some fields are HTML textareas and do not support variable suggestions, e.g. message fields in notifications. They do support ENV VARs perfectly fine, however.
You can also use multi-line environment variables in the listed actions.
If you didn't find your action here or the required field is unsupported, let us know on the live-chat or drop a line at support@buddy.works.
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. Here is the list of populated variables:
BUDDYBUDDY_WORKSPACE_URLBUDDY_WORKSPACE_IDBUDDY_WORKSPACE_NAMEBUDDY_WORKSPACE_DOMAINBUDDY_PROJECT_URLBUDDY_PROJECT_NAMEBUDDY_PROJECT_NAME_IDBUDDY_REPO_SLUGBUDDY_REPO_SSH_URLBUDDY_SCM_URLBUDDY_SCM_PROVIDERBUDDY_PIPELINE_URLBUDDY_PIPELINE_IDBUDDY_PIPELINE_NAMEBUDDY_PIPELINE_REF_NAMEBUDDY_PIPELINE_TRIGGER_MODEBUDDY_PIPELINE_TARGET_SITE_URLBUDDY_INVOKER_URLBUDDY_INVOKER_IDBUDDY_INVOKER_NAMEBUDDY_INVOKER_EMAILBUDDY_INVOKER_AVATAR_URLBUDDY_EXECUTION_URLBUDDY_EXECUTION_IDBUDDY_EXECUTION_START_DATEBUDDY_EXECUTION_MODEBUDDY_EXECUTION_CLEAR_CACHEBUDDY_EXECUTION_REFRESHBUDDY_EXECUTION_COMMENTBUDDY_EXECUTION_BRANCHBUDDY_EXECUTION_TAGBUDDY_EXECUTION_PULL_REQUEST_IDBUDDY_EXECUTION_PULL_REQUEST_NOBUDDY_EXECUTION_PULL_REQUEST_BASE_BRANCHBUDDY_EXECUTION_PULL_REQUEST_HEAD_BRANCHBUDDY_EXECUTION_PREVIOUS_REVISIONBUDDY_EXECUTION_PREVIOUS_REVISION_MESSAGEBUDDY_EXECUTION_PREVIOUS_REVISION_SUBJECTBUDDY_EXECUTION_REVISIONBUDDY_EXECUTION_REVISION_URLBUDDY_EXECUTION_REVISION_SHORTBUDDY_EXECUTION_REVISION_MESSAGEBUDDY_EXECUTION_REVISION_SUBJECTBUDDY_EXECUTION_REVISION_COMMITTER_EMAILBUDDY_EXECUTION_REVISION_COMMITTER_NAMEBUDDY_EXECUTION_CHANGELOGBUDDY_EXECUTION_CHANGELOG_ADDEDBUDDY_EXECUTION_CHANGELOG_CHANGEDBUDDY_EXECUTION_CHANGELOG_DELETEDBUDDY_EXECUTION_TIMEBUDDY_FAILED_ACTION_LOGSBUDDY_FAILED_ACTION_NAME
Below you can find a list of exemplary values for the abovementioned variables:
BUDDY=trueBUDDY_WORKSPACE_URL=https://app.buddy.works/myworkspaceBUDDY_WORKSPACE_ID=1BUDDY_WORKSPACE_NAME=My WorkspaceBUDDY_WORKSPACE_DOMAIN=myworkspaceBUDDY_PROJECT_URL=https://app.buddy.works/myworkspace/my-projectBUDDY_PROJECT_NAME=my-projectBUDDY_PROJECT_NAME_ID=my-projectBUDDY_REPO_SLUG=buddyworks/my-projectBUDDY_REPO_SSH_URL=git@github.com:buddyworks/my-projectBUDDY_SCM_URL=https://github.com/buddyworks/my-projectBUDDY_SCM_PROVIDER=GITHUBBUDDY_PIPELINE_URL=https://app.buddy.works/myworkspace/my-project/pipelines/pipeline/1BUDDY_PIPELINE_ID=1BUDDY_PIPELINE_NAME=Deploy to ProductionBUDDY_PIPELINE_REF_NAME=masterBUDDY_PIPELINE_TRIGGER_MODE=MANUALBUDDY_PIPELINE_TARGET_SITE_URL=https://buddy.works/BUDDY_INVOKER_URL=https://app.buddy.works/myworkspace/profile/1BUDDY_INVOKER_ID=1BUDDY_INVOKER_NAME=Mike BensonBUDDY_INVOKER_EMAIL=mikebenson@buddy.worksBUDDY_INVOKER_AVATAR_URL=https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/05d20f3d58ce09a3b4e9g3334a810603/w/32/32/AVATAR.pngBUDDY_EXECUTION_URL=https://app.buddy.works/myworkspace/my-project/pipelines/pipeline/1/execution/5d9dc42c422f5a268b389d08BUDDY_EXECUTION_ID=1BUDDY_EXECUTION_START_DATE=2019-01-01T11:27:40.140ZBUDDY_EXECUTION_MODE=MANUALBUDDY_EXECUTION_CLEAR_CACHE=falseBUDDY_EXECUTION_REFRESH=falseBUDDY_EXECUTION_COMMENT=My first executionBUDDY_EXECUTION_BRANCH=masterBUDDY_EXECUTION_TAG=v1.0BUDDY_EXECUTION_PULL_REQUEST_ID=pull/1BUDDY_EXECUTION_PULL_REQUEST_NO=1BUDDY_EXECUTION_PULL_REQUEST_BASE_BRANCH=masterBUDDY_EXECUTION_PULL_REQUEST_HEAD_BRANCH=master/feature1BUDDY_EXECUTION_REVISION=e5e13f8b7f8d5c6096a0501dc09b48eef05fea96BUDDY_EXECUTION_REVISION_URL=https://app.buddy.works/myworkspace/my-project/repository/commit/e5e13f8b7f8d5c6096a0501dc09b48eef05fea96BUDDY_EXECUTION_REVISION_SHORT=e5e13f8BUDDY_EXECUTION_REVISION_MESSAGE=Create buddy.ymlBUDDY_EXECUTION_REVISION_SUBJECT=Create buddy.ymlBUDDY_EXECUTION_REVISION_COMMITTER_EMAIL=mikebenson@buddy.worksBUDDY_EXECUTION_REVISION_COMMITTER_NAME=Mike BensonBUDDY_EXECUTION_CHANGELOG=[e5e13f8] Create buddy.yml | mikebenson | 2019-01-01T07:14:58BUDDY_FAILED_ACTION_NAME=Upload files
Passing variables between 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:
- The first action builds the application and saves the log output to
logs.txt. - In case the build fails, the Local Shell action assigns the content of
logs.txtto a variable usingexport LOGS=$(cat log.txt). - The logs are then sent to a Slack channel with
$LOGSas the message content.
Make sure to set the variable to Settable, otherwise it will not be possible to change its value.
Passing variables between 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.
Passing variables between pipelines
You can pass a variable between pipelines using the Run next pipeline action:
- Go into the Variables tab in the action details.
- Define the name of the variable and the value to pass:
You can assign any variable from the target pipeline as the value.
Passing variables 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:
GitHub
Bitbucket
Email