Skip to content

Commit

Permalink
docs: align the input wording
Browse files Browse the repository at this point in the history
I'd like to keep the descriptions of the inputs aligned where
possible/useful to avoid confusion about what they do.
  • Loading branch information
korthout committed Nov 5, 2023
1 parent 397d7f2 commit fe78391
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ The action can be configured with the following optional [inputs](https://docs.g

Default: `false` (disabled)

Controls wheather the assignees of the original pull request should be added to the backports.
Controls whether to copy the assignees from the original pull request to the backport pull request.
By default, the assignees are not copied.

### `copy_labels_pattern`

Expand All @@ -123,13 +124,15 @@ By default, no labels are copied.

Default: `false` (disabled)

Controls wheather the "milestone" of the original pull request should be added to the backports.
Controls whether to copy the milestone from the original pull request to the backport pull request.
By default, the milestone is not copied.

### `copy_reviewers`

Default: `false` (disabled)

Controls wheather the reviewers of the original pull request should be added to the backports.
Controls whether to copy the reviewers from the original pull request to the backport pull request.
By default, the reviewers are not copied.

### `github_token`

Expand Down
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ author: korthout
inputs:
copy_assignees:
description: >
Whether or not to copy the assignees from the original pull request to the backport pull request.
Controls whether to copy the assignees from the original pull request to the backport pull request.
By default, the assignees are not copied.
default: false
copy_labels_pattern:
Expand All @@ -15,12 +15,12 @@ inputs:
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.
Controls whether to copy the milestone from the original pull request to the backport pull request.
By default, the milestone is not copied.
default: false
copy_reviewers:
description: >
Whether or not to copy the reviewers from the original pull request to the backport pull request.
Controls whether to copy the reviewers from the original pull request to the backport pull request.
By default, the reviewers are not copied.
default: false
github_token:
Expand Down

0 comments on commit fe78391

Please sign in to comment.