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 Sep 1, 2022
1 parent a77880e commit 997d3e0
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 21 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM launchdarkly/ld-find-code-refs-github-action:2.5.7
FROM launchdarkly/ld-find-code-refs-github-action:2.6.1

LABEL com.github.actions.name="LaunchDarkly Code References"
LABEL com.github.actions.description="Find references to feature flags in your code."
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ jobs:
name: LaunchDarkly Code References
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
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/find-code-references@v2.5.7
uses: launchdarkly/find-code-references@v2.6.1
with:
accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
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.

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

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.

Expand All @@ -57,11 +57,11 @@ jobs:
name: LaunchDarkly Code References
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
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/find-code-references@v2.5.7
uses: launchdarkly/find-code-references@v2.6.1
with:
accessToken: ${{ secrets.LD_ACCESS_TOKEN }}
projKey: LD_PROJECT_KEY
Expand Down
35 changes: 20 additions & 15 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,35 @@ inputs:
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.'
required: false
accessToken:
description: 'Token with write access to LaunchDarkly project.'
description: 'A token with write access to the LaunchDarkly project.'
required: true
repoName:
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.'
description: 'The repository name. Defaults to the current GitHub repository.'
required: false
baseUri:
description: 'Set the base URL of the LaunchDarkly server for this configuration.'
description: 'The base URL of the LaunchDarkly server for this configuration.'
default: 'https://app.launchdarkly.com'
required: false
contextLines:
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.
default: 2
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.'
default: '2'
required: false
allowTags:
description: Enables storing references for tags. The tag will be listed as a branch.
default: false
description: Enable storing references for tags. The tag will be listed as a branch.
default: 'false'
required: false
debug:
description: Enables verbose debug logging.
default: false
description: Enable verbose debug logging.
default: 'false'
required: false
ignoreServiceErrors:
description: If enabled, the scanner will terminate with exit code 0 when the LaunchDarkly API is unreachable or returns an unexpected response.
default: false
description: 'If enabled, the scanner will terminate with exit code 0 when the LaunchDarkly API is unreachable or returns an unexpected response.'
default: 'false'
required: false
lookback:
description: 'Sets the number of Git commits to search in history for
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.'
default: 10
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.'
default: '10'
required: false
runs:
using: 'docker'
image: 'Dockerfile'
Expand Down

0 comments on commit 997d3e0

Please sign in to comment.