Skip to main content
This topic explains what environment release plans are and how they help your organization release features consistently.
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 is a saved release configuration for one environment. It defines the settings LaunchDarkly needs to run a release. With a plan, you define those settings once. Engineers then start a release by choosing the plan. Without a plan, the person who starts each release chooses the settings. You can create multiple plans for the same environment. For example, production can have one plan for backend changes and another for frontend changes. Plans do not apply to flag tags. To learn how to create, edit, clone, and delete plans, read Creating and managing environment release plans.

Benefits of environment release plans

Environment release plans help your organization standardize release configuration across teams. A release that starts from a plan uses the plan’s audiences, rollout steps, metrics, and automatic rollback settings, unless an engineer changes a setting in the release builder. Plans also reduce the number of settings engineers choose at release time. Automated agents benefit as well. An agent selects a plan instead of composing a release configuration, and it can start the release through the REST API.

Environment release plan settings

Each plan stores the settings that LaunchDarkly applies when you start a release from the plan. A plan includes these settings:
  • Context kind: The randomization unit for the release. LaunchDarkly uses this context kind to bucket contexts for the rollout allocation. You choose it from the Roll out by menu.
  • Phases: The stages of the release. A plan has one or more phases, and each phase targets one audience. LaunchDarkly runs the phases in order.
  • Rollout steps: The traffic progression for each phase. Each step sets the percentage of contexts that receive the new variation and how long the step lasts.
  • Metrics: The individual metrics and metric groups that LaunchDarkly monitors during the release. Metrics are optional. Each metric or metric group has an automatic rollback setting.
  • Phase advancement: Whether LaunchDarkly starts each new phase automatically when the current phase completes, or waits for you to start it.
  • Cleanup behavior: What LaunchDarkly does with the targeting rules after the release completes. A plan can leave the rules in place, or remove the rules and update the default rule to serve the released variation. You choose this under Final phase.

Audiences

An audience defines which contexts a phase targets. Each audience has one or more clauses. A clause matches contexts by segment or by attribute condition.

Release type

The number of phases and metrics in a plan determines the type of release that LaunchDarkly creates:
  • A plan with one phase creates a single-phase release. A plan with multiple phases creates an audience-based release. To learn more, read Audience-based releases.
  • A plan with one or more metrics creates a guarded rollout. A plan with no metrics creates a progressive rollout. To learn more, read Guarded rollouts and Progressive rollouts.
To learn more about release methods, read Releasing features with LaunchDarkly. The Example: standardize production releases for checkout changes section shows how these settings work together.

Start a release from a plan

To start a release from a plan, click Ship it on a flag’s Targeting tab and choose a plan for the environment. LaunchDarkly opens the release builder with the plan’s settings applied. You select the variations to roll out. You can change any setting before you click Review and save. Only complete plans appear in the list of plans you can choose from. A plan is incomplete when it is missing settings that a release requires. Plans that LaunchDarkly migrated from release policies can be incomplete. You must add the missing settings before you can use the plan. To learn how, read Complete an incomplete plan.

Example: standardize production releases for checkout changes

An organization wants every production release of its checkout service to start with internal users and expand only when metrics show no regressions. A release engineer creates a plan for the production environment. The plan includes these settings:
  • Context kind: The user context kind.
  • Phases: The first phase targets internal users with a clause that matches email addresses ending in the organization’s domain. The second phase keeps the default audience, which matches every context of the user context kind.
  • Rollout steps: Each phase has three rollout steps.
  • Metrics: One checkout conversion metric, with automatic rollback turned on.
  • Phase advancement: Automatic.
  • Cleanup behavior: LaunchDarkly removes the targeting rules and updates the default rule after the release completes.
Engineers who release a checkout change choose this plan when they click Ship it. LaunchDarkly starts the internal users phase, advances to the second phase automatically, and rolls back the release if it detects a regression in the metric. Every production release of the checkout service that starts from this plan then uses the same audiences, steps, and metric.

Existing release policies

LaunchDarkly migrated existing release policies to environment release plans in a one-time migration. LaunchDarkly does not migrate release policies that you create after the migration. To learn how to complete a migrated plan that is missing settings, read Complete an incomplete plan.