To complete this procedure, you must have the following prerequisites:
- A personal API access token with
writerpermissions, stored as a repository secret titled
LD_ACCESS_TOKEN. To learn more, read Personal API access tokens.
To set up
- Log into GitHub and navigate to your repo.
- Navigate to Settings > Secrets and click Add a new secret.
- Paste in your access token to the field that appears and click Save secret.
GitHub's secret configuration screen.
- Return to your GitHub repository to create a new Actions workflow.
- If you already have a
action.ymlfile: Copy and paste the
launchDarklyCodeReferencesjob declaration below into the jobs section in your
- If you don't already have a workflow file: Create a new file titled
.github/workflowsdirectory of your repository. Paste the following code in the Edit file section:
- If you already have a
onpush nameExample Workflow jobs launchDarklyCodeReferences nameLaunchDarkly Code References runs-onubuntu-latest steps usesactions/checkout@v1 nameLaunchDarkly Code References useslaunchdarkly/find-code-references@v3 env GITHUB_TOKEN$ secrets.GITHUB_TOKEN LD_ACCESS_TOKEN$ secrets.LD_ACCESS_TOKEN LD_PROJ_KEYYOUR_PROJECT_KEY
Best practices for configuring an Actions file
We strongly recommend that you update the second
uses attribute value to reference the latest tag in the launchdarkly/find-code-references repository.
This pins your workflow to a particular version of the launchdarkly/find-code-references action.
- Commit this file under a new branch and submit as a PR to your code reviewers to be merged into your master branch.
Code references are not blocked by PR approval
You do not need to have this branch merged into the master branch for code references to appear in the LaunchDarkly UI; code references will appear for this newly created branch.
As shown in the example above, the workflow should run on the
push event and contain an action provided by the launchdarkly/find-code-references repository.
Include both the
LD_ACCESS_TOKEN as a secret and a new environment variable containing your LaunchDarkly project key.
Once your workflow is created, the best way to confirm that the workflow is executing correctly is to create a new pull request with the workflow file and verify that the newly created action succeeds.
If the action fails, there may be a problem with your configuration. To investigate, review the action's logs to view any error messages.
You can configure
ld-find-code-refs with additional environment variables to enable more functionality.
A LaunchDarkly personal access token with writer-level access, or access to the
code-reference-repository custom role resource. Supply this as a GitHub repository secret.
A LaunchDarkly project key. The flag finder searches this project for code references in this project.
A regular expression (PCRE) defining the files and directories which the flag finder should exclude. Partial matches are allowed.
The number of context lines above and below a code reference for the flag finder to send to LaunchDarkly.
If < 0, no source code will be sent to LaunchDarkly.
If 0, only the lines containing flag references will be sent.
If > 0, will send that number of context lines above and below the flag reference.
A maximum of 5 context lines may be provided. Defaults to 2.
Set the base URL of the LaunchDarkly server for this configuration. Defaults to https://app.launchdarkly.com.
Enables verbose default logging. Defaults to
Specifies additional delimiters used to match flag keys. Must be a non-control ASCII character. If you provide more than one character in delimiters, each character is treated as a separate delimiter.
This only matches flag keys surrounded by any of the specified delimeters.
You can also specify this option multiple times for multiple delimiters. By default, only flags delimited by single-quotes, double-quotes, and backticks are matched.
Here's an example of a workflow configured to exclude the vendor directory and send 1 line of context above and below each code reference for each flag in the
onpush nameExample Workflow jobs launchDarklyCodeReferences nameLaunchDarkly Code References runs-onubuntu-latest steps usesactions/checkout@v1 nameLaunchDarkly Code References useslaunchdarkly/find-code-references@v3 env GITHUB_TOKEN$ secrets.GITHUB_TOKEN LD_ACCESS_TOKEN$ secrets.LD_ACCESS_TOKEN LD_PROJ_KEYYOUR_PROJECT_KEY LD_EXCLUDE"vendor/" LD_CONTEXT_LINES"1"