No results for ""
EXPAND ALL
  • Home
  • API docs

Adding and removing flags from release pipelines

Read time: 3 minutes
Last edited: Aug 16, 2024

Overview

This topic explains how to add, remove, and move flags between existing release pipelines.

After you have created a release pipeline, you are redirected to the releases view to add your first flags to the pipeline. You can add only boolean flags to release pipelines.

Add flags to release pipelines

To add a flag to a release pipeline:

  1. From the flags list, navigate to the boolean flag you want to add to a release pipeline.
  2. Click Start release in the right sidebar. If there is more than one release available, select the release you want to add the flag to.
The "Start release" option.
The "Start release" option.

The release appears in the right sidebar.

You can also use the REST API: Create a new release for flag

Begin phases

After you have set up the automation for each of your phases, you can begin a phase for an individual flag. This activates the automation within that phase for that flag.

To begin a phase for a flag:

  1. From the flag's targeting page, find the phase you want to begin in the right sidebar.
  2. Click the start arrow for the phase. A "Start phase" dialog appears
  3. Click Start.

Release pipelines run the following automated steps when you start the phase for a flag:

  • If the phase includes an approval, starting the phase sends an approval request to toggle the flag on. When the approval request is approved and applied, then LaunchDarkly automatically toggles the flag.
  • If the phase includes a guarded rollout, starting the phase automatically begins the monitoring process for the time specified in the phase.

When the phase is complete, the next phase in the release pipeline is marked as "Ready to start."

A release pipeline's phases in a flag's sidebar.
A release pipeline's phases in a flag's sidebar.

When you're ready for the flag to move through the next phase, click the start arrow for that phase.

Each time a flag begins or completes a phase, anyone following the flag receives an email notification and, if you have the Slack integration configured, a Slack notification.

You can also use the REST API: Update phase status for release

Move flags between release pipelines

If a flag is already assigned to a release pipeline, you can move it to another pipeline.

To move a flag:

  1. Navigate to the flag's targeting page.
  2. In the right sidebar, click the three-dot overflow menu for the release.
  3. Hover over Move to pipeline and select the release you want to move the flag to.
  4. Enter the name or key of the release to confirm.
  5. Click Move.

Remove flags from release pipelines

To remove a flag from a release pipeline:

  1. Navigate to the flag's targeting page.
  2. In the right sidebar, click the three-dot overflow menu for the release.
  3. Click Cancel release.

You can also use the REST API: Delete a release for flag