Document the OKTETO_IS_PREVIEW_ENVIRONMENT environment variable (#703)

okteto · Apr 17, 2024 · eb79481 · eb79481
1 parent 0e0e9cf
commit eb79481
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/src/content/core/okteto-variables.mdx b/src/content/core/okteto-variables.mdx
@@ -116,7 +116,8 @@ These are automatically expanded and can be referenced in your Okteto manifest
 - **`OKTETO_USERNAME`**: Your username in Okteto.
 - **`OKTETO_REGISTRY_URL`**: The URL of the Okteto Registry.
 - **`OKTETO_GIT_BRANCH`**: The name of the Git branch being deployed.
-- **`OKTETO_GIT_COMMIT`**: The SHA1 hash of the last commit of the branch.
+- **`OKTETO_GIT_COMMIT`**: The SHA1 hash of the last commit of the branch
+- **`OKTETO_IS_PREVIEW_ENVIRONMENT`**: Set to `true` when the environment is [a preview environment](previews/index.mdx). 
 
 ### **Built-in Environment Variables for Images in Okteto Registry**
 

diff --git a/versioned_docs/version-1.19/core/okteto-variables.mdx b/versioned_docs/version-1.19/core/okteto-variables.mdx
@@ -117,6 +117,7 @@ These are automatically expanded and can be referenced in your Okteto manifest
 - **`OKTETO_REGISTRY_URL`**: The URL of the Okteto Registry.
 - **`OKTETO_GIT_BRANCH`**: The name of the Git branch being deployed.
 - **`OKTETO_GIT_COMMIT`**: The SHA1 hash of the last commit of the branch.
+- **`OKTETO_IS_PREVIEW_ENVIRONMENT`**: Set to `true` when the environment is [a preview environment](previews/index.mdx).
 
 ### **Built-in Environment Variables for Images in Okteto Registry**