Skip to content

Commit

Permalink
docs: sort inputs lexicographically
Browse files Browse the repository at this point in the history
Whether this is the best ordering is subjective, but I prefer a specific
ordering like this until I see a better one (perhaps by categories or
so).
  • Loading branch information
korthout committed Nov 5, 2023
1 parent 0283b4d commit 364fd87
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 32 deletions.
38 changes: 18 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,12 @@ jobs:
The action can be configured with the following optional [inputs](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith):
### `copy_assignees`

Default: `''` (disabled)

Controls wheather the assignees of the original pull request should be added to the backports.

### `copy_labels_pattern`

Default: `''` (disabled)
Expand All @@ -113,6 +119,18 @@ Regex pattern to match github labels which will be copied from the original pull
Note that labels matching `label_pattern` are excluded.
By default, no labels are copied.

### `copy_milestone`

Default: `''` (disabled)

Controls wheather the "milestone" of the original pull request should be added to the backports.

### `copy_reviewers`

Default: `''` (disabled)

Controls wheather the reviewers of the original pull request should be added to the backports.

### `github_token`

Default: `${{ github.token }}`
Expand Down Expand Up @@ -185,26 +203,6 @@ See [How it works](#how-it-works).
Can be used in addition to backport labels.
By default, only backport labels are used to specify the target branches.


### `copy_milestone`

Default: `''` (disabled)

Controls wheather the "milestone" of the original pull request should be added to the backports.

### `copy_assignees`

Default: `''` (disabled)

Controls wheather the assignees of the original pull request should be added to the backports.

### `copy_reviewers`

Default: `''` (disabled)

Controls wheather the reviewers of the original pull request should be added to the backports.


## Placeholders
In the `pull_description` and `pull_title` inputs, placeholders can be used to define variable values.
These are indicated by a dollar sign and curly braces (`${placeholder}`).
Expand Down
24 changes: 12 additions & 12 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,23 @@ description: >
Fast and flexible action to cherry-pick commits from labeled pull requests
author: korthout
inputs:
copy_assignees:
description: >
Whether or not to copy the assignees from the original pull request to the backport pull request.
By default, the assignees are not copied.
copy_labels_pattern:
description: >
Regex pattern to match github labels which will be copied from the original pull request to the backport pull request.
Note that labels matching `label_pattern` are excluded.
By default, no labels are copied.
copy_milestone:
description: >
Whether or not to copy the milestone from the original pull request to the backport pull request.
By default, the milestone is not copied.
copy_reviewers:
description: >
Whether or not to copy the reviewers from the original pull request to the backport pull request.
By default, the reviewers are not copied.
github_token:
description: >
Token to authenticate requests to GitHub.
Expand Down Expand Up @@ -53,18 +65,6 @@ inputs:
Note that the pull request's headref is excluded automatically.
Can be used in addition to backport labels.
By default, only backport labels are used to specify the target branches.
copy_milestone:
description: >
Whether or not to copy the milestone from the original pull request to the backport pull request.
By default, the milestone is not copied.
copy_assignees:
description: >
Whether or not to copy the assignees from the original pull request to the backport pull request.
By default, the assignees are not copied.
copy_reviewers:
description: >
Whether or not to copy the reviewers from the original pull request to the backport pull request.
By default, the reviewers are not copied.
outputs:
was_successful:
description: >
Expand Down

0 comments on commit 364fd87

Please sign in to comment.