Skip to content

Commit

Permalink
docs: reorder inputs by priority (#34)
Browse files Browse the repository at this point in the history
Order by priority with required inputs at the top
  • Loading branch information
jazanne authored Jun 30, 2023
1 parent c33490f commit 00ff5c0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ jobs:
| parameter | description | required | default |
| --- | --- | --- | --- |
| project-key | LaunchDarkly Project | `false` | default |
| environment-key | LaunchDarkly environment for setting flag links. Can be a comma-separated list of environment keys. | `false` | production |
| base-uri | The base URI for the LaunchDarkly server. Most users should use the default value. | `false` | https://app.launchdarkly.com |
| repo-token | Token to use to authorize comments on PR. Typically the GITHUB_TOKEN secret. | `true` | |
| access-token | LaunchDarkly access token | `true` | |
| project-key | LaunchDarkly Project | `false` | default |
| environment-key | LaunchDarkly environment for setting flag links. Can be a comma-separated list of environment keys. | `false` | production |
| placeholder-comment | Comment even if no flags are found. If flags are found in later commits this comment will be updated. | `false` | false |
| 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 |
<!-- action-docs-inputs -->

<!-- action-docs-outputs -->
Expand Down
20 changes: 10 additions & 10 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ runs:
LD_ENV_KEY: ${{ inputs.environment-key }}
GITHUB_TOKEN: ${{ inputs.repo-token }}
inputs:
repo-token:
description: 'Token to use to authorize comments on PR. Typically the GITHUB_TOKEN secret.'
required: true
access-token:
description: 'LaunchDarkly access token'
required: true
project-key:
description: 'LaunchDarkly Project'
required: false
Expand All @@ -19,16 +25,6 @@ inputs:
description: 'LaunchDarkly environment for setting flag links. Can be a comma-separated list of environment keys.'
required: false
default: 'production'
base-uri:
description: 'The base URI for the LaunchDarkly server. Most users should use the default value.'
required: false
default: 'https://app.launchdarkly.com'
repo-token:
description: 'Token to use to authorize comments on PR. Typically the GITHUB_TOKEN secret.'
required: true
access-token:
description: 'LaunchDarkly access token'
required: true
placeholder-comment:
description: 'Comment even if no flags are found. If flags are found in later commits this comment will be updated.'
required: false
Expand All @@ -37,6 +33,10 @@ inputs:
description: 'Maximum number of flags to find per PR'
required: false
default: '5'
base-uri:
description: 'The base URI for the LaunchDarkly server. Most users should use the default value.'
required: false
default: 'https://app.launchdarkly.com'

outputs:
any-modified:
Expand Down

0 comments on commit 00ff5c0

Please sign in to comment.