Skip to main content
This topic explains how to create, edit, clone, and delete environment release plans.
Environment release plans are available to customers on select plansEnvironment release plans are available to customers on an Enterprise plan with the Guardian add-on. To learn more, read about our pricing. To upgrade your plan, contact Sales.
An environment release plan stores the settings LaunchDarkly needs to run a release in one environment. To learn more about what a plan includes, read Environment release plans. To learn how to start a release from a plan, read Start a release from a plan.
You can also use the REST API: Environment release plans.

Prerequisites

Before you create a plan, complete the following prerequisites:
  • Confirm you have permission to create, update, and delete plans. Custom roles need the createEnvironmentReleasePlan, updateEnvironmentReleasePlan, and deleteEnvironmentReleasePlan actions. To learn more, read Environment release plan actions.
  • Confirm you have access to audience-based releases. Creating multi-phase guarded environment release plans requires this access.
  • Create the segments you want to use as audiences. A plan can reference only segments that exist in the plan’s environment. To learn more, read Segments.
  • Create the metrics or metric groups you want to monitor. The metrics you select must support the context kind that you choose as the randomization unit. To learn more, read Setting up contexts for guarded rollouts.

Create an environment release plan

Create a plan to apply the same release settings each time engineers release a flag in an environment. You create plans in the release settings for each project. To create an environment release plan:
  1. Click the gear icon in the left sidebar. The settings page opens.
  2. Click Release settings. The release settings page appears.
  3. Click the Environment release plans tab.
  4. Click Create.
  5. Enter a name for the plan. LaunchDarkly creates a key based on the name. You can edit the key before you save the plan, but you cannot change the key after you create the plan.
  6. (Optional) Enter a description for the plan.
  7. Select the environment where the plan applies. You cannot change the environment after you create the plan. To use the same settings in another environment, clone the plan.
  8. (Optional) Select Default for environment to preselect the plan when engineers start a release in this environment. Each environment has one default plan, and a new default replaces the previous one.
  9. From the Roll out by menu, select the context kind to use as the randomization unit. You can choose any context kind that is not archived.
  10. (Optional) From the Monitor for regressions menu, select the individual metrics or metric groups to monitor. For each one, choose whether LaunchDarkly rolls back the release automatically when it detects a regression.
  11. For Phase advancement, click Manual to start each phase yourself, or click Automatic to let LaunchDarkly start each phase when the previous phase completes.
  12. Define the first phase:
    • Enter a name for the phase.
    • Under Audience, review the clause for the context kind you selected. To narrow the audience, click Add clause. A clause matches contexts by segment or by attribute condition.
    • Under Rollout, enter the percentage of contexts that receive the new variation and how long the step lasts. To add another step, click Add Step.
  13. (Optional) To add a phase, click Add phase. Each phase has its own name, audience, and rollout. To change the order of phases, use the arrows next to the phase name.
  14. Under Final phase, choose what happens when the last phase completes:
    • Click Release to everyone to remove the release rules and set the default rule to serve the released variation.
    • Click Keep the release limited to this audience to leave the release rules in place. Only the audience you define receives the released variation, and everyone else is unchanged.
  15. Click Save.
LaunchDarkly adds the plan to the list. To learn how to start a release from the plan, read Start a release from a plan.

View environment release plans

The Environment release plans tab lists the plans in your project. The list includes these columns:
  • Name: The name of the plan, with its description below.
  • Environment: The environment where the plan applies.
  • Configuration: The number of phases and the duration of the release.
  • Monitoring: The number of metrics the plan monitors, or “None” when the plan has no metrics.
  • Advancement: Whether LaunchDarkly advances through phases automatically or waits for you to start each phase. The values are “Automatic” and “Manual.”
Use the three-dot menu at the end of a row to work with a plan.

Edit an environment release plan

You can change the name, description, and settings of a plan. You cannot change the key or the environment. To edit an environment release plan:
  1. Navigate to the Environment release plans tab in the release settings.
  2. Find the plan you want to edit.
  3. Click the three-dot menu at the end of the row, then click Edit.
  4. Change the settings you want to update.
  5. Click Save.
When you save changes to a plan, new releases use the updated settings. Releases that already started do not change.

Complete an incomplete plan

Plans that LaunchDarkly migrated from release policies can be incomplete. You cannot use an incomplete plan to start a release. To complete a plan:
  1. Navigate to the Environment release plans tab in the release settings.
  2. Click the name of the incomplete plan. The form shows the settings that LaunchDarkly migrated from the release policy.
  3. Add the missing settings. A plan requires a context kind and at least one phase.
  4. Click Save. LaunchDarkly does not save the plan until every required setting has a value.

Clone an environment release plan

Clone a plan to reuse its settings in another environment or to create a variation of an existing plan. Audiences use segments, and segments do not necessarily exist in every environment. Review the audiences in the clone before you save it. To clone an environment release plan:
  1. Navigate to the Environment release plans tab in the release settings.
  2. Find the plan you want to clone.
  3. Click the three-dot menu at the end of the row, then click Clone.
  4. Enter a name for the new plan.
  5. Select the environment where the new plan applies.
  6. Review the audiences and other settings, and change any that do not apply to the new environment.
  7. Click Save.

Delete an environment release plan

Delete a plan when you no longer want engineers to use it. To delete an environment release plan:
  1. Navigate to the Environment release plans tab in the release settings.
  2. Find the plan you want to delete.
  3. Click the three-dot menu at the end of the row, then click Delete.
  4. Confirm the deletion.
Deleted environment release plans cannot be restoredWhen you delete a plan, LaunchDarkly removes it from your project, and you cannot restore it.
You cannot delete a segment while an active plan references it. To delete the segment, first delete the plan or remove the segment from the plan’s audiences.