From b50838b6414e64b2f85b5fa6bcdf7f2683fb7fbe Mon Sep 17 00:00:00 2001
From: Nico Korthout <nico.korthout@camunda.com>
Date: Fri, 20 Jan 2023 14:45:11 +0100
Subject: [PATCH] docs: describe outputs

To help users easily find the available outputs, they are now documented
in the README.
---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index b84f80c..ae8d4f3 100644
--- a/README.md
+++ b/README.md
@@ -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