Skip to content

Commit

Permalink
Release auto update version
Browse files Browse the repository at this point in the history
  • Loading branch information
yusinto committed Feb 16, 2022
1 parent c3130d9 commit 6264459
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
@@ -1,4 +1,4 @@
FROM launchdarkly/ld-find-code-refs-github-action:2.5.0
FROM launchdarkly/ld-find-code-refs-github-action:2.5.4

LABEL com.github.actions.name="LaunchDarkly Code References"
LABEL com.github.actions.description="Find references to feature flags in your code."
Expand Down
40 changes: 36 additions & 4 deletions README.md
Expand Up @@ -12,20 +12,24 @@ Next, create a new Actions workflow in your selected GitHub repository (e.g. `co

```yaml
on: push
name: Example Workflow
name: Find LaunchDarkly flag code references
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
launchDarklyCodeReferences:
name: LaunchDarkly Code References
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
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
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
- name: LaunchDarkly Code References
uses: launchdarkly/[email protected].0
uses: launchdarkly/[email protected].4
with:
accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
projKey: YOUR_PROJECT_KEY
projKey: LD_PROJECT_KEY
```

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.
Expand All @@ -34,6 +38,34 @@ Commit this file under a new branch. Submit as a PR to your code reviewers to b

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.

## Additional Examples
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.

```yaml
on:
push:
branches-ignore:
- 'dependabot/**'

name: Find LaunchDarkly flag code references
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
launchDarklyCodeReferences:
name: LaunchDarkly Code References
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
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
- name: LaunchDarkly Code References
uses: launchdarkly/[email protected]
with:
accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
projKey: LD_PROJECT_KEY
```
## Troubleshooting

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.
Expand Down

0 comments on commit 6264459

Please sign in to comment.