Add docs for GITLAB_ENV variable (!151019) · Merge requests · GitLab.org / GitLab · GitLab

Adam Cohen requested to merge update-env-var-passing-docs into master Apr 26, 2024

What does this MR do and why?

While reviewing https://gitlab.com/gitlab-org/security-products/oxeye/product/lightz/-/merge_requests/180+s, I noticed the use of the $GITLAB_ENV variable, as discussed here, but couldn't find any documentation for it. This lead to some confusion regarding the capabilities of this variable as discussed here.

This MR adds documentation for the $GITLAB_ENV variable, in order to reduce confusion. Support for the $GITLAB_ENV variable was originally introduced by Allow passing of env vars between job stages/steps (gitlab-runner!3708 - merged) • Arran Walker • 16.4,

Screenshots or screen recordings

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.