Skip to content

Commit 6264459

Browse files
committed
Release auto update version
1 parent c3130d9 commit 6264459

File tree

2 files changed

+37
-5
lines changed

2 files changed

+37
-5
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM launchdarkly/ld-find-code-refs-github-action:2.5.0
1+
FROM launchdarkly/ld-find-code-refs-github-action:2.5.4
22

33
LABEL com.github.actions.name="LaunchDarkly Code References"
44
LABEL com.github.actions.description="Find references to feature flags in your code."

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,24 @@ Next, create a new Actions workflow in your selected GitHub repository (e.g. `co
1212

1313
```yaml
1414
on: push
15-
name: Example Workflow
15+
name: Find LaunchDarkly flag code references
16+
concurrency:
17+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
18+
cancel-in-progress: true
19+
1620
jobs:
1721
launchDarklyCodeReferences:
1822
name: LaunchDarkly Code References
1923
runs-on: ubuntu-latest
2024
steps:
2125
- uses: actions/checkout@v2
2226
with:
23-
fetch-depth: 11 # 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
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
2428
- name: LaunchDarkly Code References
25-
uses: launchdarkly/find-code-references@v2.5.0
29+
uses: launchdarkly/find-code-references@v2.5.4
2630
with:
2731
accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
28-
projKey: YOUR_PROJECT_KEY
32+
projKey: LD_PROJECT_KEY
2933
```
3034
3135
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.
@@ -34,6 +38,34 @@ Commit this file under a new branch. Submit as a PR to your code reviewers to b
3438

3539
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.
3640

41+
## Additional Examples
42+
The example below is the same as first, but it also excludes any `dependabot` branches. We suggest excluding any automatically generated branches where flags do not change.
43+
44+
```yaml
45+
on:
46+
push:
47+
branches-ignore:
48+
- 'dependabot/**'
49+
50+
name: Find LaunchDarkly flag code references
51+
concurrency:
52+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
53+
cancel-in-progress: true
54+
55+
jobs:
56+
launchDarklyCodeReferences:
57+
name: LaunchDarkly Code References
58+
runs-on: ubuntu-latest
59+
steps:
60+
- uses: actions/checkout@v2
61+
with:
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
63+
- name: LaunchDarkly Code References
64+
uses: launchdarkly/find-code-references@v2.5.4
65+
with:
66+
accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
67+
projKey: LD_PROJECT_KEY
68+
```
3769
## Troubleshooting
3870

3971
Once your workflow has been 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.

0 commit comments

Comments
 (0)