Commit 6d06aa14 authored by Amy Qualls's avatar Amy Qualls

Merge branch '218032-update-freeze-period_docs' into 'master'

Update Freeze Period documentation

Closes #218032

See merge request gitlab-org/gitlab!32526
parents dc56b531 6141961a
...@@ -11,7 +11,7 @@ interact with the Freeze Period API endpoints. ...@@ -11,7 +11,7 @@ interact with the Freeze Period API endpoints.
## List Freeze Periods ## List Freeze Periods
Paginated list of Freeze Periods, sorted by `created_at`. Paginated list of Freeze Periods, sorted by `created_at` in ascending order.
```plaintext ```plaintext
GET /projects/:id/freeze_periods GET /projects/:id/freeze_periods
......
...@@ -371,7 +371,7 @@ freeze periods, all will apply, and should they overlap, the freeze covers the ...@@ -371,7 +371,7 @@ freeze periods, all will apply, and should they overlap, the freeze covers the
complete overlapped period. complete overlapped period.
During pipeline processing, GitLab CI creates an environment variable named During pipeline processing, GitLab CI creates an environment variable named
`$CI_ENVIRONMENT_FROZEN` if the currently executing job is within a `$CI_DEPLOY_FREEZE` if the currently executing job is within a
Freeze Period. Freeze Period.
To take advantage of this variable, create a `rules` entry in your To take advantage of this variable, create a `rules` entry in your
...@@ -384,7 +384,7 @@ deploy_to_production: ...@@ -384,7 +384,7 @@ deploy_to_production:
stage: deploy stage: deploy
script: deploy_to_prod.sh script: deploy_to_prod.sh
rules: rules:
- if: $CI_ENVIRONMENT_FROZEN == null - if: $CI_DEPLOY_FREEZE == null
``` ```
<!-- ## Troubleshooting <!-- ## Troubleshooting
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment