• Home
  • Integrations
  • SDKs
  • Guides
  • API docs
No results for ""
EXPAND ALL

EDIT ON GITHUB

CircleCI Orbs

Read time: 1 minute
Last edited: Oct 26, 2021
Code references is an Enterprise feature

Code references is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

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:

  • An API access token with writer permissions. To learn more, read API access tokens.
  • The LaunchDarkly CircleCI Orb.
Circle Workflow version 2.1 or higher is requiredTo 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 to create your own workflow job.

Setting up the LaunchDarkly CircleCI integration

To set up the LaunchDarkly orb in CircleCI:

  1. Save your 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:
1version: 2.1
2
3orbs:
4 launchdarkly: launchdarkly/ld-find-code-refs@2.1.0
5
6workflows:
7 main:
8 jobs:
9 - launchdarkly/find-code-references:
10 proj_key: $YOUR_LAUNCHDARKLY_PROJECT_KEY
11 repo_type: github # can be 'github', 'bitbucket', or 'custom'
12 repo_url: $YOUR_REPO_URL # used to generate links to your repository

Additional configuration options

There are more configuration options for the Code references orb. To learn more, read Explore Orbs / launchdarkly/ld-find-code-refs.

Skip searching files and directories with an .ldignore file.

Use the .launchdarkly/coderefs.yaml file for advanced configuration, such as configuring custom delimiters and aliases for your flag keys.