No results for ""
  • Home
  • API docs


Release flags

Read time: 2 minutes
Last edited: May 01, 2024


This topic explains how you can use release flags to progressively roll out functionality. Release flags are temporary flags that initially do not serve the new functionality, then progressively roll out the functionality until they reach 100%.

Understanding release flags

Release flags, sometimes called rollout flags, are temporary boolean flags with two variations: "Available" (true) and "Unavailable" (false).

In the most common use case, you wrap a release flag around code for a new or improved feature, and use the flag to release the new feature to your customers in increments. Release flags are temporary. After you verify the new code is stable and roll out the feature to 100% of your customers, you should delete the flag.

To create a release flag:

  1. Navigate to the flags list.
  2. Click Create flag. The "Create new flag" page appears.
  3. Enter a unique, human-readable Name.
  4. (Optional) Update the flag Key. You'll use this key to reference the flag in your code. A suggested key auto-populates from the name you enter, but you can customize it if you wish.
  5. (Optional) Enter a Description of the flag. A brief, human-readable description helps your account members understand what the flag is for.
  6. (Optional) Update the Maintainer for the flag.
  7. (Optional) Check the Include flag in this project's release pipeline box. To learn more, read Release pipelines.
  8. (Optional) Choose any Metrics to monitor in the Metrics section. To learn more, read Metrics.
  9. Choose the Release flag template in the Configuration section:
The "Configuration" section of the "Create new flag" page.
The "Configuration" section of the "Create new flag" page.
  1. Choose Yes or No to indicate whether this flag is temporary. Release flags are usually temporary.
  2. Select the Boolean flag type.
  3. (Optional) In the "Variations" section, update variations as needed.
  4. (Optional) Update the default variations.
  5. Choose one or more tags from the Tags menu.
  6. Check the SDKs using Mobile Key and/or SDKs using client-side ID boxes to indicate which client-side SDKs you will use to evaluate this flag. If you are using a server-side SDK, leave these boxes unchecked.
  7. Click Create flag.

To learn more, read Creating new flags.

Because release or rollout flags are used to release a new feature in increments, they typically do not use complex targeting rules. Instead, they serve a percentage rollout in their default rule. To learn more, read Percentage rollouts.

If you have a well-defined process for releasing new features gradually, we recommend using a workflow with your release flag. A workflow is a set of actions that you can schedule in advance to make changes to a feature flag. For a release flags, you can schedule a gradual increase in the percentage of contexts targeted by the flag. To learn more, read Workflows.