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

reference for built-in env vars #24020

Merged
merged 5 commits into from
Aug 29, 2024
Merged

reference for built-in env vars #24020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3bfe463
first pass env var ref
jamiedemaria Aug 28, 2024
fc81ffa
reference for built-in env vars
jamiedemaria Aug 28, 2024
04ac4a2
format env var names as code
jamiedemaria Aug 28, 2024
f44ce37
nothing
jamiedemaria Aug 29, 2024
e8840e8
specify seconds for timestamp
jamiedemaria Aug 29, 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
31 changes: 30 additions & 1 deletion docs/docs-beta/docs/dagster-plus/deployment/environment-variables/built-in.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,33 @@
sidebar_label: "Built-in variables"
---

# Built-in environment variables

[Dagster+](/todo) provides a set of built-in, automatically populated environment variables, such as the name of a deployment or details about a branch deployment commit, that can be used to modify behavior based on environment.

### All deployment variables

The following variables are available in every deployment of your Dagster+ instance.

| Key | Value |
|---|---|
| `DAGSTER_CLOUD_DEPLOYMENT_NAME` | The name of the Dagster+ deployment. <br/><br/> **Example:** `prod`. |
jamiedemaria marked this conversation as resolved.
Show resolved Hide resolved
| `DAGSTER_CLOUD_IS_BRANCH_DEPLOYMENT` | `1` if the deployment is a branch deployment. |


### Branch deployment variables

The following environment variables are available only in a [branch deployment](/todo).

For every commit made to a branch, the following environment variables are available:

| Key | Value |
|---|---|
| `DAGSTER_CLOUD_GIT_SHA` | The SHA of the commit. |

Check warning on line 29 in docs/docs-beta/docs/dagster-plus/deployment/environment-variables/built-in.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.acronyms] Spell out 'SHA', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Dagster.acronyms] Spell out 'SHA', if it's unfamiliar to the audience.", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/environment-variables/built-in.md", "range": {"start": {"line": 29, "column": 33}}}, "severity": "INFO"}
| `DAGSTER_CLOUD_GIT_TIMESTAMP` | The Unix timestamp in seconds when the commit occurred. <br/><br/> **Example:** `1724871941` |
| `DAGSTER_CLOUD_GIT_AUTHOR_EMAIL` | The email of the git user who authored the commit. |
| `DAGSTER_CLOUD_GIT_AUTHOR_NAME` | The name of the git user who authored the commit. |
| `DAGSTER_CLOUD_GIT_MESSAGE` | The message associated with the commit. |
| `DAGSTER_CLOUD_GIT_BRANCH` | The name of the branch associated with the commit. |
| `DAGSTER_CLOUD_GIT_REPO` | The name of the repository associated with the commit. |
| `DAGSTER_CLOUD_PULL_REQUEST_ID` | The ID of the pull request associated with the commit. |
| `DAGSTER_CLOUD_PULL_REQUEST_STATUS` | The status of the pull request at the time of the commit. <br/><br/> **Possible values:** `OPEN`, `CLOSED`, and `MERGED`. |
2 changes: 0 additions & 2 deletions docs/docs-beta/docs/dagster-plus/deployment/serverless/transition-hybrid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@ title: "Transitioning to Hybrid"
displayed_sidebar: "dagsterPlus"
sidebar_position: 50
---

# Transition from Serverless to Hybrid
Loading