Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity

docs: change requests for segments (#4476)

Browse Source
This commit is contained in:
Mateusz Kwasniewski 2023-08-11 09:48:37 +02:00 committed by GitHub
parent a68942d90f
commit 90f5af6b61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
website/docs/reference/change-requests.md
View File

@ -7,6 +7,7 @@ import VideoContent from '@site/src/components/VideoContent.jsx';
:::info Availability :::info Availability
The change requests feature is an enterprise-only feature that was introduced in **Unleash 4.19.0**. The change requests feature is an enterprise-only feature that was introduced in **Unleash 4.19.0**.
The change requests for segments was introduced in **Unleash 5.4.0**.
::: :::
@ -72,12 +73,14 @@ Change requests have their own set of environment-specific permissions that can
- approve change requests - approve change requests
- apply change requests - apply change requests
- skip the change request flow **when using the API directly** - skip the change request flow
None of the predefined roles have any change request permissions, so you must create your own project roles to take advantage of change requests. In other words, even a user with the project "owner" role can not approve or apply change requests. None of the predefined roles have any change request permissions, so you must create your own project roles to take advantage of change requests. In other words, even a user with the project "owner" role can not approve or apply change requests.
There is no permission to create change requests: **Anyone can create change requests**, even Unleash users with the [root viewer role](rbac.md#predefined-roles). Change requests don't cause any changes until approved and applied by someone with the correct permissions. There is no permission to create change requests: **Anyone can create change requests**, even Unleash users with the [root viewer role](rbac.md#predefined-roles). Change requests don't cause any changes until approved and applied by someone with the correct permissions.
You can prevent non-project members from submitting change requests by setting a [protected project collaboration mode](project-collaboration-mode.md).
### Circumventing change requests ### Circumventing change requests
The **skip change requests** permission allows users to bypass the change request flow. Users with this permission can change feature toggles directly (they are of course still limited by any other permissions they have). The **skip change requests** permission allows users to bypass the change request flow. Users with this permission can change feature toggles directly (they are of course still limited by any other permissions they have).
@ -85,3 +88,16 @@ The **skip change requests** permission allows users to bypass the change reques
The skip change requests permission was designed to make it possible to quickly turn something off in the event that a feature release didn't go as expected or was causing issues. The skip change requests permission was designed to make it possible to quickly turn something off in the event that a feature release didn't go as expected or was causing issues.
The skip change requests permission does **not** grant any other permissions, so to be allowed to do things as enabling/disabling a toggle, the user will still need the explicit permissions to do that too. The skip change requests permission does **not** grant any other permissions, so to be allowed to do things as enabling/disabling a toggle, the user will still need the explicit permissions to do that too.
In the UI non-admin users with **skip change requests** permission and explicit permission to perform the actual action will be able to make changes directly without change requests.
Admin users will always see the change request UI so that they can test the change request flow. Admin users can however self-approve and self-apply their own changes.
## Change Request for segments
Changes to project [segments](segments.mdx) (as opposed to global segments) also go through the change request process. This is to prevent a backdoor in the change request process.
Since projects segments are not environment specific and change requests are always environment specific we allow to attach segment change to any environment with change requests enabled.
When you make changes though the Change Request UI it will automatically select first environment with change requests enabled, giving priority to [production](environments.md#environment-types) environments.
Changes to segments can be only circumvented by admin users through the API calls.