Skip to content

Commit

Permalink
docs: describe outputs
Browse files Browse the repository at this point in the history
To help users easily find the available outputs, they are now documented
in the README.
  • Loading branch information
korthout committed Jan 20, 2023
1 parent 06c5bc0 commit b50838b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,15 @@ Placeholder | Replaced with
`pull_title` | The title of the original pull request that is backported, e.g. `fix: some error`
`target_branch`| The branchname to which the pull request is backported, e.g. `release-0.23`

## Outputs

The action provides the following [outputs](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idoutputs):

Output | Description
-------|------------
`was_successful` | Whether or not the changes could be backported successfully to all targets. Either `true` or `false`.
`was_successful_by_target` | Whether or not the changes could be backported successfully to all targets - broken down by target. Follows the pattern `{{label}}=true\|false`.

## Local compilation

Install the dependencies
Expand Down

0 comments on commit b50838b

Please sign in to comment.