• HOME
  • INTEGRATIONS
  • SDKS
  • GUIDES
  • API DOCS
No results for ""
EXPAND ALL
CLOSE
launchdarkly.com

EDIT ON GITHUB

GitHub Actions

Read time: 1 minute
Last edited: Jun 29, 2020

Overview

This topic explains how to use the ld-find-code-refs utility with GitHub Actions 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, stored as a repository secret titled LD_ACCESS_TOKEN. To learn more, read API access tokens.

Setting up GitHub Actions

To set up:

  1. Log into GitHub and navigate to your repo.

  2. Navigate to Settings > Secrets and click Add a new secret.

  3. Paste in your access token to the field that appears and click Save secret.

  4. Return to your GitHub repository to create a new Actions workflow.

  • If you already have a action.yml file: Copy and paste the launchDarklyCodeReferences job declaration below into the jobs section in your action.yml file.
  • If you don't already have a workflow file: Create a new file titled action.yml in the .github/workflows directory of your repository. Paste the following code in the Edit file section:
1on: push
2name: Example Workflow
3jobs:
4 launchDarklyCodeReferences:
5 name: LaunchDarkly Code References
6 runs-on: ubuntu-latest
7 steps:
8 - uses: actions/checkout@v2
9 - name: LaunchDarkly Code References
10 uses: launchdarkly/find-code-references@v5
11 with:
12 githubToken: ${{ secrets.GITHUB_TOKEN }}
13 accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
14 projKey: YOUR_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.

  1. 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.

Troubleshooting

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.

Additional configuration options

You can configure ld-find-code-refs with additional inputs to enable more functionality.

VariableDescriptionRequired
accessTokenA LaunchDarkly access token with writer-level access, or access to the code-reference-repository custom role resource. Supply this as a GitHub repository secret.Yes
projKeyA LaunchDarkly project key. The flag finder searches this project for code references in this project.Yes
excludeA regular expression (PCRE) defining the files and directories which the flag finder should exclude. Partial matches are allowed.
Examples: vendor/, vendor/.*
No
contextLinesThe 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.
No
baseUriSet the base URL of the LaunchDarkly server for this configuration. Defaults to https://app.launchdarkly.com.No
debugEnables verbose default logging. Defaults to false.No
delimitersSpecifies 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.
Default: [" ' `]
No
ignoreServiceErrorsOptional.
If enabled, the scanner will terminate with exit code 0 when the LaunchDarkly API is unreachable or returns an unexpected response. Defaults to false

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 default project:

1on: push
2name: Example Workflow
3jobs:
4 launchDarklyCodeReferences:
5 name: LaunchDarkly Code References
6 runs-on: ubuntu-latest
7 steps:
8 - uses: actions/checkout@v1
9 - name: LaunchDarkly Code References
10 uses: launchdarkly/find-code-references@v3
11 env:
12 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
13 LD_ACCESS_TOKEN: ${{ secrets.LD_ACCESS_TOKEN }}
14 LD_PROJ_KEY: YOUR_PROJECT_KEY
15 LD_EXCLUDE: "vendor/"
16 LD_CONTEXT_LINES: "1"