diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ddea1cd..4e53e8b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ### Added +- Create flag links will be on by default + ### Changed ### Fixed diff --git a/README.md b/README.md index edbb9bc2..bd08eb85 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ # LaunchDarkly Find Code References in Pull Request GitHub action -Adds a comment to a pull request (PR) whenever a feature flag reference is found in a PR diff. +Adds a comment to a pull request (PR) whenever a feature flag reference is found in a PR diff and creates a [flag link](https://docs.launchdarkly.com/home/organize/links) in LaunchDarkly. - An example code references PR comment +An example GitHub pull request flag link + ## Permissions This action requires a [LaunchDarkly access token](https://docs.launchdarkly.com/home/account-security/api-access-tokens) with: * Read access for the designated `project-key` -* (Optional) the `createFlagLink` action, if you have set the `create-flag-links` input to `true` +* (Optional) the `createFlagLink` action, when [`create-flag-links` input is `true` (default behavior)](#inputs) Access tokens should be stored as an [encrypted secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets). @@ -107,7 +108,7 @@ This action does not support monorepos or searching for flags across LaunchDarkl | `max-flags` |

Maximum number of flags to find per PR

| `false` | `5` | | `base-uri` |

The base URI for the LaunchDarkly server. Most members should use the default value.

| `false` | `https://app.launchdarkly.com` | | `check-extinctions` |

Check if removed flags still exist in codebase

| `false` | `true` | -| `create-flag-links` |

Create links to flags in LaunchDarkly. To use this feature you must use an access token with the createFlagLink role. To learn more, read Flag links.

| `false` | `false` | +| `create-flag-links` |

Create links to flags in LaunchDarkly. To use this feature you must use an access token with the createFlagLink role. To learn more, read Flag links.

| `false` | `true` | diff --git a/action.yml b/action.yml index 96863990..15dca12c 100644 --- a/action.yml +++ b/action.yml @@ -48,7 +48,7 @@ inputs: create-flag-links: description: Create links to flags in LaunchDarkly. To use this feature you must use an access token with the `createFlagLink` role. To learn more, read [Flag links](https://docs.launchdarkly.com/home/organize/links). required: false - default: 'false' + default: 'true' outputs: any-modified: description: Returns true if any flags have been added or modified in PR diff --git a/images/example-flag-link.png b/images/example-flag-link.png new file mode 100644 index 00000000..5c1704fd Binary files /dev/null and b/images/example-flag-link.png differ