LaunchDarkly Developer Documentation

Get started in under 30 minutes.
LaunchDarkly provides feature flags as a service for Java · Python · Ruby · Go · Node.js · PHP · .NET. Control feature launches -- who sees what and when -- without multiple code deploys. Easy dashboard for phased rollouts, targeting and segmenting.
Need more help? write us at support@launchdarkly.com

Get Started    Documentation

CircleCI Orbs

Overview

This topic explains how you can use the ld-find-code-refs utility with CircleCi to automatically populate code references in LaunchDarkly.

Prerequisites

To complete this procedure, you must have the following prerequisites:

Circle Workflow version 2.1 or higher is required

To use CircleCI Orbs, you must be using a Circle Workflow version of 2.1 or higher.

If you're using an earlier version, try manually using the utility binary or docker image to create your own workflow job.

Setting up the LaunchDarkly CircleCI integration

To set up the LaunchDarkly orb in CircleCI:

  1. Save your personal API access token as an environment variable titled LD_ACCESS_TOKEN in your CircleCI project settings. To learn more, read CircleCI's documentation.
  2. Create a YAML file in CircleCI with configuration including LaunchDarkly's Orb.
    Here's an example minimal configuration using LaunchDarkly's Orb:
version: 2.1

orbs:
  launchdarkly: launchdarkly/ld-find-code-refs@0.5.0

workflows:
  main:
    jobs:
      - launchdarkly/find-code-references:
          proj_key: $YOUR_LAUNCHDARKLY_PROJECT_KEY
          repo_type: github # can be 'github', 'bitbucket', or 'custom'
          repo_url: $YOUR_REPO_URL # used to generate links to your repository in the LaunchDarkly webapp

Additional configuration options

You can learn more about configuration options in CircleCI's documentation. To learn more, read Explore Orbs / launchdarkly/ld-find-code-refs.


CircleCI Orbs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.