Flag approval requests and reviews

3 minute read

Feature flag approval requests add a structured review step before changes are applied to a flag configuration supporting governance, collaboration, and accountability across teams. This is especially important when feature flags affect production environments or regulated workflows.

Users can choose to request approval before applying changes, while users with read-only access must submit proposed changes for review and wait for approval from someone with write permissions.

Read through this page to understand how the approval workflow functions from both the requester and reviewer perspectives, and what each role is responsible for during the process.

The flag change and review process
Approval request work flow
Figure 1. The flag change and review process.

How to request approval for a flag change

After making changes to a flag’s configuration, you can submit the update as a proposal for review and approval. The changes won’t take effect until they are approved.

To propose a flag configuration change:

  1. Navigate to Feature management.

  2. Select the application.

  3. Select the flag name from the list of flags.

  4. Make the desired configuration changes.

  5. Depending on your assigned permissions, select the available option:

    Request approval button based on permissions
    Figure 2. Submit request approval.
    1. Select Request approval if you have read-only access to the flag configuration.

    2. Select Save configuration  Request approval if you have write access to the flag configuration.

  1. Select Request approval to continue.

    Final request approval
    Figure 3. Final submit request approval.

    After successfully submitting the approval request, the flag configuration page changes.

    Page locked with diff view
    Figure 4. Example of a locked page with diff view.
    1. The flag configuration for this environment becomes locked while the approval is pending.

      • Locking applies to this flag in this environment only.

      • Cloning is disabled while the flag is locked.

      • The Configuration status toggle can still be turned off.

      • The warning banner explains that the flag is locked for editing, and approval is pending.

      • Only the requester can select Withdraw request.

    2. A vertical diff view shows the current configuration (top) and the proposed changes (bottom).

CloudBees platform sends email notifications to the approver(s) and to the requester to keep them informed of the approval status as follows:

  1. Check your email for the approval confirmation message.

    • Reviewers (users with approval permission) receive an email when a flag change proposal is submitted for approval.

    • When one of those reviewers accepts the review request, the requester receives a confirmation email that includes the reviewer’s name.

      Request accepted email
      Figure 5. Email request accepted for review.
    • If the change request is approved, the changes are applied to the flag configuration immediately.

    • If the change request is rejected, the requester receives an email, similar to the one shown below.

      Request rejected email
      Figure 6. Email approval rejected.

      If the proposed change is rejected and the change is still needed, submit a new approval request.

How reviewers manage approval requests

When an approval request is submitted, users with the appropriate permission receive an email notification about the proposed change that includes a link to accept the review request.

  1. Locate the email from feature management requesting a review, similar to the image below.

    Email  review requested
    Figure 7. Email requesting a review.
  2. Select Respond to request.

    • The requester receives an email notification that you have accepted the review request.

    • The flag configuration screen opens to the page with the proposed change.

  3. View the flag configuration change.

  4. Select Review approval request to open the approval request dialog to proceed.

    Open the approval request dialog
    Figure 8. Open the approval request dialog.
  5. Add comments to the Approval request dialog. Comments are required to complete the process.

    Approval request dialog
    Figure 9. Approval request dialog.
  6. Select one of the following:

    • Approve the request.

      • The change is applied immediately.

      • The requester receives an email explaining that their request has been approved.

    • Reject the request.

      • Discard the proposed change and retain the existing configuration unchanged.

      • The requester is notified via email that their request is rejected.

Rejected changes are deleted.

If changes requiring approval are still necessary, a new approval request must be submitted.

For details on permission levels and custom roles to support the approval request process, refer to creating custom roles.