From 364fd879b22c4e31d5e44145f4898d6d485f38d2 Mon Sep 17 00:00:00 2001 From: Nico Korthout Date: Sun, 5 Nov 2023 13:41:08 +0100 Subject: [PATCH] docs: sort inputs lexicographically 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). --- README.md | 38 ++++++++++++++++++-------------------- action.yml | 24 ++++++++++++------------ 2 files changed, 30 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index d0918ad..4517b01 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 }}` @@ -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}`). diff --git a/action.yml b/action.yml index 4599bb2..6f9a945 100644 --- a/action.yml +++ b/action.yml @@ -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. @@ -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: >