Built-in Environment Variables

About 1694 wordsAbout 6 min

Cloud Native Build includes some default environment variables that are read-only. Attempting to override these variables during builds will not take effect.

The following merge-related events include:

pull_request
pull_request.update
pull_request.target
pull_request.approved
pull_request.changes_requested
pull_request.mergeable
pull_request.merged
pull_request.comment

Learn more about trigger events.

Basic Variables

CI

true

CNB

true

CNB_WEB_PROTOCOL

Current web protocol: http | https

CNB_WEB_HOST

Current web address including protocol, HOST, and path (if any)

CNB_WEB_ENDPOINT

Current API endpoint including protocol, HOST, and path (if any)

Can be used with CNB_TOKEN to call API interfaces in CI

CNB_API_ENDPOINT

Current API endpoint including protocol, HOST, and path (if any)

Can be used with CNB_TOKEN to call API interfaces in CI

CNB_GROUP_SLUG

Repository organization path

CNB_GROUP_SLUG_LOWERCASE

Repository organization path (lowercase format)

CNB_EVENT

Name of the event that triggered the build

Event types see events

CNB_EVENT_URL

For builds triggered by merge-related events, value is the Pull Request link
For builds triggered by push, branch.create, tag_push, value is the latest Commit link
Otherwise empty string

CNB_BRANCH

For builds triggered by push, branch.create, branch.delete, value is current branch name
For builds triggered by merge-related events, value is target branch name
For builds triggered by tag_push, value is tag name
For builds triggered by custom events, value is corresponding branch name
For builds triggered by crontab, value is corresponding branch name

CNB_BRANCH_SHA

For builds triggered by branch.delete, empty string
Otherwise latest commit sha of CNB_BRANCH

CNB_DEFAULT_BRANCH

Repository default branch

CNB_TOKEN_USER_NAME

Temporary token username, fixed as cnb

CNB_TOKEN

Temporary user tokens (destroyed at the end of the pipeline) can be used for pulling, pushing code and artifacts, as well as making API calls.

If the repository associated with the pipeline is a public repository, the scope of the token's usage will be restricted to public repositories/artifact repositories only.

For the pull_request, pull_request.update, pull_request.approved, and pull_request.changes_requested events, the permissions include:

repo-code:r
repo-pr:r
repo-issue:r
repo-notes:rw
repo-contents:r
registry-package:r
repo-commit-status:rw
account-profile:r

For other events, the permissions include:

repo-code:rw
repo-pr:rw
repo-issue:rw
repo-notes:rw
repo-contents:rw
registry-package:rw
repo-commit-status:rw
repo-cnb-trigger:rw
repo-cnb-history:r
repo-cnb-detail:r
repo-basic-info:r
repo-manage:r
account-profile:r
group-resource:r

Refer to permissions in Personal Settings > Access Tokens

CNB_TOKEN_FOR_AI

User token used by AI in pull_request events and web_trigger events

Permissions:

repo-notes:rw
repo-pr:rw

Refer to permissions in Personal Settings > Access Tokens

CNB_IS_CRONEVENT

Whether it's a scheduled task event

CNB_DOCKER_REGISTRY

Artifact Docker registry address

CNB_HELM_REGISTRY

Artifact Helm registry address

CNB_HAS_LFS_FILES

Whether there are LFS files

If the repository is emptied of LFS files, it will still be set to true before Git GC

Commit Variables

CNB_BEFORE_SHA

For builds triggered by push or commit.add, the value is the sha of the most recent commit in the remote repository for that branch before the push. If it is a newly created branch, the value is 0000000000000000000000000000000000000000.
For builds triggered by branch.create, the value is 0000000000000000000000000000000000000000.

CNB_COMMIT

Commit sha corresponding to the build:

For builds triggered by push,commit.add, branch.create, it's the latest commit sha
For builds triggered by tag_push, tag_deploy.*, it's the latest commit sha of the tag
For builds triggered by auto_tag, branch.delete, issue.*, it's the latest commit sha of the main branch
For builds triggered by pull_request.merged, it's the merged sha
For builds triggered by pull_request.target, pull_request.mergeable, it's the latest commit sha of the target branch
For builds triggered by pull_request, pull_request.approved, pull_request.changes_requested, pull_request.comment, code hasn't been actually merged yet, takes the latest commit sha of the source branch, but the build will perform a pre-merge, meaning the merged content will be the final result
For builds triggered by Workspaces, custom events, it's the latest commit sha of the specified branch

Tag message: For builds where the branch is a Tag, this environment variable exists
Otherwise empty string

CNB_TAG_RELEASE_TITLE

Release title: For builds where the branch is a Tag, if Release title is not empty, there will be a value
Otherwise empty string

CNB_TAG_RELEASE_DESC

Release description: For builds where the branch is a Tag, and Release description is not empty, there will be a value
Otherwise empty string

CNB_TAG_IS_RELEASE

Whether Tag has corresponding Release: For builds where the branch is a Tag, if Tag has corresponding Release, then true
Otherwise false

CNB_TAG_IS_PRE_RELEASE

For builds where the branch is a Tag, if corresponding Release exists, and Release is pre-release, then value is true
Otherwise false

success: Indicates that the pipeline build has completed successfully.
error: Indicates that an error occurred during the pipeline build process.
cancel: Indicates that the pipeline build was canceled.

For builds triggered by pull_request, pull_request.update, pull_request.target, value is true
Otherwise false

CNB_PULL_REQUEST_LIKE

For builds triggered by merge-related events, value is true
Otherwise false

CNB_PULL_REQUEST_PROPOSER

For builds triggered by merge-related events, value is PR proposer name
Otherwise empty string

CNB_PULL_REQUEST_TITLE

For builds triggered by merge-related events, value is PR title
Otherwise empty string

CNB_PULL_REQUEST_BRANCH

For builds triggered by merge-related events, value is PR source branch name
Otherwise empty string

CNB_PULL_REQUEST_SHA

For builds triggered by merge-related events, value is latest commit sha of PR source branch
Otherwise empty string

CNB_PULL_REQUEST_TARGET_SHA

For builds triggered by merge-related events, value is latest commit sha of PR target branch
Otherwise empty string

CNB_PULL_REQUEST_MERGE_SHA

For builds triggered by pull_request.merged, value is merged sha
For builds triggered by pull_request, pull_request.update, pull_request.target, pull_request.mergeable, pull_request.comment, value is pre-merged sha
Otherwise empty string

CNB_PULL_REQUEST_SLUG

For builds triggered by merge-related events, value is source repository slug, e.g. group_slug/repo_name, group_slug/sub_gourp_slog/.../repo_name
Otherwise empty string

CNB_PULL_REQUEST_ACTION

For builds triggered by merge-related events, possible values:

created: New PR
code_update: Source branch push
status_update: When review approved or CI status changes PR becomes mergeable
Otherwise empty string

CNB_PULL_REQUEST_ID

For builds triggered by merge-related events, value is globally unique id of current or related PR
Otherwise empty string

CNB_PULL_REQUEST_IID

For builds triggered by merge-related events, value is iid number of current or related PR in repository
Otherwise empty string

CNB_PULL_REQUEST_REVIEWERS

For builds triggered by merge-related events, value is reviewer list, multiple separated by ,
Otherwise empty string

CNB_PULL_REQUEST_REVIEW_STATE

For builds triggered by merge-related events:

Has reviewers and someone approved, value is approve
Has reviewers but no one approved, value is unapprove
Otherwise empty string

CNB_REVIEW_REVIEWED_BY

For builds triggered by merge-related events, value is approved reviewer list, multiple separated by ,
Otherwise empty string

CNB_REVIEW_LAST_REVIEWED_BY

For builds triggered by merge-related events, value is last approved reviewer
Otherwise empty string

CNB_PULL_REQUEST_IS_WIP

For builds triggered by merge-type events, the value is true or false, indicating whether the PR has been set to [WIP].
Otherwise, the value is an empty string.