diff --git a/Makefile b/Makefile index 5e4daa89..93ae8fd3 100644 --- a/Makefile +++ b/Makefile @@ -1,2 +1,2 @@ docs: - npx action-docs -u --no-banner -t 3 + npx action-docs -u --no-banner -t 3 --source action.yml diff --git a/README.md b/README.md index c08290bb..edbb9bc2 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ You can find more information on aliases at [launchdarkly/ld-find-code-refs](htt This action does not support monorepos or searching for flags across LaunchDarkly projects. - + ### Inputs | name | description | required | default | @@ -108,37 +108,23 @@ This action does not support monorepos or searching for flags across LaunchDarkl | `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` | - -### Inputs + -| parameter | description | required | default | -| --- | --- | --- | --- | -| repo-token | Token to use to authorize comments on PR. Typically the `GITHUB_TOKEN` secret or equivalent `github.token`. | `true` | | -| access-token | LaunchDarkly access token | `true` | | -| project-key | LaunchDarkly project key | `false` | default | -| environment-key | LaunchDarkly environment key for creating flag links | `false` | production | -| placeholder-comment | Comment on PR when no flags are found. If flags are found in later commits, this comment will be updated. | `false` | false | -| include-archived-flags | Scan for archived flags | `false` | true | -| max-flags | Maximum number of flags to find per PR | `false` | 5 | -| base-uri | The base URI for the LaunchDarkly server. Most users should use the default value. | `false` | https://app.launchdarkly.com | -| check-extinctions | Check if removed flags still exist in codebase | `false` | true | - - - + ### Outputs -| parameter | description | +| name | description | | --- | --- | -| any-modified | Returns true if any flags have been added or modified in PR | -| modified-flags | Space-separated list of flags added or modified in PR | -| modified-flags-count | Number of flags added or modified in PR | -| any-removed | Returns true if any flags have been removed in PR | -| removed-flags | Space-separated list of flags removed in PR | -| removed-flags-count | Number of flags removed in PR | -| any-changed | Returns true if any flags have been changed in PR | -| changed-flags | Space-separated list of flags changed in PR | -| changed-flags-count | Number of flags changed in PR | -| any-extinct | Returns true if any flags have been removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true. | -| extinct-flags | Space-separated list of flags removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true. | -| extinct-flags-count | Number of flags removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true. | - +| `any-modified` |

Returns true if any flags have been added or modified in PR

| +| `modified-flags` |

Space-separated list of flags added or modified in PR

| +| `modified-flags-count` |

Number of flags added or modified in PR

| +| `any-removed` |

Returns true if any flags have been removed in PR

| +| `removed-flags` |

Space-separated list of flags removed in PR

| +| `removed-flags-count` |

Number of flags removed in PR

| +| `any-changed` |

Returns true if any flags have been changed in PR

| +| `changed-flags` |

Space-separated list of flags changed in PR

| +| `changed-flags-count` |

Number of flags changed in PR

| +| `any-extinct` |

Returns true if any flags have been removed in PR and no longer exist in codebase. Only returned if check-extinctions is true.

| +| `extinct-flags` |

Space-separated list of flags removed in PR and no longer exist in codebase. Only returned if check-extinctions is true.

| +| `extinct-flags-count` |

Number of flags removed in PR and no longer exist in codebase. Only returned if check-extinctions is true.

| + diff --git a/action.yml b/action.yml index 382e8056..96863990 100644 --- a/action.yml +++ b/action.yml @@ -49,7 +49,6 @@ inputs: 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' - outputs: any-modified: description: Returns true if any flags have been added or modified in PR