Skip to content

Commit 605ab54

Browse files
authored
docs: environment change requests (#9648)
1 parent 3447b03 commit 605ab54

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

website/docs/reference/change-requests.mdx

+23-4
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ import VideoContent from '@site/src/components/VideoContent.jsx';
1313
## Overview
1414

1515
Change requests allow you to require an additional approval step before any changes can be made in an environment. This functionality supports the "four-eyes principle", ensuring compliance in industries with strict legal or regulatory requirements.
16-
16+
1717
Change requests also allow you to group changes and [apply them at a specific point in time](#scheduled-change-requests).
1818

19-
Change requests can be enabled on a per-project and per-environment basis. This allows you to differentiate your configurations across different environments, such as production and development.
19+
Change requests can be enabled for a specific environment within a project, or configured globally for an environment across all projects. This allows you to differentiate your configurations across different environments, such as production and development.
2020

2121
You can require up to 10 approvals for a change request.
2222

@@ -78,7 +78,7 @@ Alternatively, you can use constraints or segments with the `DATE_AFTER` [operat
7878
### Scheduling errors
7979

8080
Unleash suspends a scheduled change request if:
81-
- The change request includes updates to a flag that has been archived or a strategy that has been deleted.
81+
- The change request includes updates to a flag that has been archived or a strategy that has been deleted.
8282
- The change request includes a strategy, segment, or variant that has been updated.
8383
- The user who scheduled a change request is deleted from the users list before the scheduled time.
8484

@@ -104,8 +104,27 @@ While change requests are environment-specific, project segments are not. For th
104104

105105
Only Admin users can bypass the change request process for project segments through API calls.
106106

107+
## Environment-level change requests
108+
109+
:::note Availability
110+
111+
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.10+`
112+
113+
:::
114+
115+
You can preconfigure change request requirements at the environment level. When configured, all new projects automatically inherit these approval requirements for the specified environments.
116+
117+
You can use environment-level change requests in two ways:
118+
119+
* **As defaults**: Set default approvals per environment, but allow project [Owners](/reference/rbac#projects#predefined-roles) and users with [project update permissions](/reference/rbac#projects) to override the defaults within their projects.
120+
* **As enforced requirements**: Set mandatory approvals for a given environment across all projects. To fully enforce this in a project, ensure that the project has no Owner or users with project update permissions—this prevents any change request modifications at the project level.
121+
122+
You can predefine environment-level change requests when creating or editing an environment in **Configure > Environments**.
123+
124+
![Environment-level change requests](/img/environment-level-change-requests.png)
125+
107126
## Change request preview
108127

109128
To verify a change request, you can preview the changes in [Playground](/reference/playground) by clicking **Preview changes**. You can adjust [Unleash context](/reference/playground#the-unleash-context), but the project and environment remain fixed as they are determined by the change request.
110129

111-
You can only preview a change request in **In Review**, **Approved**, or **Scheduled** states.
130+
You can only preview a change request in **In Review**, **Approved**, or **Scheduled** states.
Loading

0 commit comments

Comments
 (0)