CircleCI code references

Code references are available to customers on select plans

Code references are only available to customers on select plans. 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:

Circle Workflow version 2.1 or higher is required

To use CircleCI code references, 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. To learn more, read Execution via CLI in the ld-find-code-refs documentation.

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
    1version: 2.1
    2
    3orbs:
    4  launchdarkly: launchdarkly/ld-find-code-refs@2.12.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 '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.

Built with