Skip to content

Commit

Permalink
docs: clarify source_pr_number input behavior
Browse files Browse the repository at this point in the history
Note that this is not specific to the workflow_dispatch event type. It
should also work for other event types.
  • Loading branch information
korthout committed Aug 21, 2024
1 parent f6b4356 commit a5011fa
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,9 @@ inputs:
[Backport ${target_branch}] ${pull_title}
source_pr_number:
description: >
Specifty the pull request number to backport instead of detecting based on the pull request closed event.
Only valid when github.event_type == "workflow_dispatch".
Specifies the pull request (by its number) to backport, i.e. the source pull request.
When set, the action will backport the specified pull request to each target branch.
When not set, the action determines the source pull request from the event payload.
target_branches:
description: >
The action will backport the pull request to each specified target branch (space-delimited).
Expand Down

0 comments on commit a5011fa

Please sign in to comment.