CircleCI code references

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 write permissions for the code-reference-repository resource, either through a base role, a LaunchDarkly-provided project role, or another role that you have created. To learn more, read API access tokens and Code reference actions.
• The LaunchDarkly CircleCI Orb.

Set 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:

   YAML

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

Additional configuration options

There are additional configuration options for the code references orb.

To skip searching files and directories, use an .ldignore file.

To configure custom delimiters and aliases for your flag keys, or to set other advanced configuration, use the .launchdarkly/coderefs.yaml file.