You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,19 +22,19 @@ jobs:
22
22
name: LaunchDarkly Code References
23
23
runs-on: ubuntu-latest
24
24
steps:
25
-
- uses: actions/checkout@v2
25
+
- uses: actions/checkout@v3
26
26
with:
27
27
fetch-depth: 10# This value must be set if the lookback configuration option is not disabled for find-code-references. Read more: https://github.com/launchdarkly/ld-find-code-refs#searching-for-unused-flags-extinctions
28
28
- name: LaunchDarkly Code References
29
-
uses: launchdarkly/find-code-references@v2.5.7
29
+
uses: launchdarkly/find-code-references@v2.6.1
30
30
with:
31
31
accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
32
32
projKey: LD_PROJECT_KEY
33
33
```
34
34
35
35
We strongly recommend that you update the second `uses` attribute value to reference the latest tag in the [launchdarkly/find-code-references repository](https://github.com/launchdarkly/find-code-references). This will pin your workflow to a particular version of the `launchdarkly/find-code-references` action. Also, make sure to change `projKey` to the key of the LaunchDarkly project associated with this repository.
36
36
37
-
Commit this file under a new branch. Submit as a PR to your code reviewers to be merged into your master branch. You do not need to have this branch merged into the master for code references to appear in the LaunchDarkly UI for your flags; code references will appear for this newly created branch.
37
+
Commit this file under a new branch. Submit as a PR to your code reviewers to be merged into your default branch. You do not need to have this branch merged into the default branch for code references to appear in the LaunchDarkly UI for your flags; code references will appear for this newly created branch.
38
38
39
39
As shown in the above example, the workflow should run on the `push` event, and contain an action provided by the [launchdarkly/find-code-references repository](https://github.com/launchdarkly/find-code-references). The `LD_ACCESS_TOKEN` configured in the previous step should be included as a secret, as well as a new environment variable containing your LaunchDarkly project key.
40
40
@@ -57,11 +57,11 @@ jobs:
57
57
name: LaunchDarkly Code References
58
58
runs-on: ubuntu-latest
59
59
steps:
60
-
- uses: actions/checkout@v2
60
+
- uses: actions/checkout@v3
61
61
with:
62
62
fetch-depth: 10 # This value must be set if the lookback configuration option is not disabled for find-code-references. Read more: https://github.com/launchdarkly/ld-find-code-refs#searching-for-unused-flags-extinctions
Copy file name to clipboardExpand all lines: action.yml
+20-15Lines changed: 20 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -9,30 +9,35 @@ inputs:
9
9
description: 'Key of the LaunchDarkly project associated with this repository. Found under Account Settings -> Projects in the LaunchDarkly dashboard. Cannot be combined with `projects` block in configuration file.'
10
10
required: false
11
11
accessToken:
12
-
description: 'Token with write access to LaunchDarkly project.'
12
+
description: 'A token with write access to the LaunchDarkly project.'
13
13
required: true
14
14
repoName:
15
-
description: 'Sets the repository name for this project. This is useful if you have a single monorepo containing multiple YAML configurations each mapping to its own projKey. Each YAML configuration must have a unique LD_PROJ_KEY and LD_REPO_NAME combination so it displays correctly in the LaunchDarkly dashboard. Defaults to the current Github repository.'
15
+
description: 'The repository name. Defaults to the current GitHub repository.'
16
+
required: false
16
17
baseUri:
17
-
description: 'Set the base URL of the LaunchDarkly server for this configuration.'
18
+
description: 'The base URL of the LaunchDarkly server for this configuration.'
18
19
default: 'https://app.launchdarkly.com'
20
+
required: false
19
21
contextLines:
20
-
description:
21
-
The number of context lines above and below a code reference for the job to send to LaunchDarkly. By default, the flag finder will not send any context lines 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.
22
-
default: 2
22
+
description:'The number of context lines above and below a code reference for the job to send to LaunchDarkly. By default, the flag finder will not send any context lines 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.'
23
+
default: '2'
24
+
required: false
23
25
allowTags:
24
-
description: Enables storing references for tags. The tag will be listed as a branch.
25
-
default: false
26
+
description: Enable storing references for tags. The tag will be listed as a branch.
27
+
default: 'false'
28
+
required: false
26
29
debug:
27
-
description: Enables verbose debug logging.
28
-
default: false
30
+
description: Enable verbose debug logging.
31
+
default: 'false'
32
+
required: false
29
33
ignoreServiceErrors:
30
-
description: If enabled, the scanner will terminate with exit code 0 when the LaunchDarkly API is unreachable or returns an unexpected response.
31
-
default: false
34
+
description: 'If enabled, the scanner will terminate with exit code 0 when the LaunchDarkly API is unreachable or returns an unexpected response.'
35
+
default: 'false'
36
+
required: false
32
37
lookback:
33
-
description: 'Sets the number of Git commits to search in history for
34
-
whether a feature flag was removed from code. May be set to 0 to disabled this feature. Setting this option to a high value will increase search time.'
35
-
default: 10
38
+
description: 'Set the number of commits to search in history for whether you removed a feature flag from code. You may set to 0 to disable this feature. Setting this option to a high value will increase search time.'
0 commit comments