Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changing syntax #6281

Merged
merged 3 commits into from
Oct 14, 2024
Merged

Changing syntax #6281

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c84dba6
Changing syntax
matthewshaver Oct 11, 2024
62a9124
Merge branch 'current' into emdash
mirnawong1 Oct 14, 2024
70498c2
Update environment-variables.md
mirnawong1 Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions website/docs/docs/build/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ dbt Cloud has a number of pre-defined variables built in. Variables are set auto

The following environment variable is set automatically for the dbt Cloud IDE:

- `DBT_CLOUD_GIT_BRANCH`: Provides the development Git branch name in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud).
- `DBT_CLOUD_GIT_BRANCH` — Provides the development Git branch name in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @matthewshaver added the — to the ide one too

- Available in dbt v 1.6 and later.
- The variable changes when the branch is changed.
- Doesn't require restarting the IDE after a branch change.
Expand All @@ -113,26 +113,26 @@ Use case — This is useful in cases where you want to dynamically use the G

The following environment variables are set automatically:

- `DBT_ENV`: This key is reserved for the dbt Cloud application and will always resolve to 'prod'. For deployment runs only.
- `DBT_CLOUD_ENVIRONMENT_NAME`: The name of the dbt Cloud environment in which `dbt` is running.
- `DBT_CLOUD_ENVIRONMENT_TYPE`: The type of dbt Cloud environment in which `dbt` is running. The valid values are `development` or `deployment`.
- `DBT_ENV` — This key is reserved for the dbt Cloud application and will always resolve to 'prod'. For deployment runs only.
- `DBT_CLOUD_ENVIRONMENT_NAME` — The name of the dbt Cloud environment in which `dbt` is running.
- `DBT_CLOUD_ENVIRONMENT_TYPE` — The type of dbt Cloud environment in which `dbt` is running. The valid values are `development` or `deployment`.

#### Run details

- `DBT_CLOUD_PROJECT_ID`: The ID of the dbt Cloud Project for this run
- `DBT_CLOUD_JOB_ID`: The ID of the dbt Cloud Job for this run
- `DBT_CLOUD_RUN_ID`: The ID of this particular run
- `DBT_CLOUD_RUN_REASON_CATEGORY`: The "category" of the trigger for this run (one of: `scheduled`, `github_pull_request`, `gitlab_merge_request`, `azure_pull_request`, `other`)
- `DBT_CLOUD_RUN_REASON`: The specific trigger for this run (eg. `Scheduled`, `Kicked off by <email>`, or custom via `API`)
- `DBT_CLOUD_ENVIRONMENT_ID`: The ID of the environment for this run
- `DBT_CLOUD_ACCOUNT_ID`: The ID of the dbt Cloud account for this run
- `DBT_CLOUD_PROJECT_ID` &mdash; The ID of the dbt Cloud Project for this run
- `DBT_CLOUD_JOB_ID` &mdash; The ID of the dbt Cloud Job for this run
- `DBT_CLOUD_RUN_ID` &mdash; The ID of this particular run
- `DBT_CLOUD_RUN_REASON_CATEGORY` &mdash; The "category" of the trigger for this run (one of: `scheduled`, `github_pull_request`, `gitlab_merge_request`, `azure_pull_request`, `other`)
- `DBT_CLOUD_RUN_REASON` &mdash; The specific trigger for this run (eg. `Scheduled`, `Kicked off by <email>`, or custom via `API`)
- `DBT_CLOUD_ENVIRONMENT_ID` &mdash; The ID of the environment for this run
- `DBT_CLOUD_ACCOUNT_ID` &mdash; The ID of the dbt Cloud account for this run

#### Git details

_The following variables are currently only available for GitHub, GitLab, and Azure DevOps PR builds triggered via a webhook_

- `DBT_CLOUD_PR_ID`: The Pull Request ID in the connected version control system
- `DBT_CLOUD_GIT_SHA`: The git commit SHA which is being run for this Pull Request build
- `DBT_CLOUD_PR_ID` &mdash; The Pull Request ID in the connected version control system
- `DBT_CLOUD_GIT_SHA` &mdash; The git commit SHA which is being run for this Pull Request build


### Example usage
Expand Down
Loading