Merge pull request #598 from mikepenz/feature/additional_output

Additional action output
mikepenz · Jul 15, 2022 · e41d91d · e41d91d
2 parents 8b8d3c8 + b76182b
commit e41d91d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -88,6 +88,23 @@ jobs:
 | `update_check`    | Optional. Uses an alternative API to update checks, use for cases with more than 50 annotations.                                                                   |
 | `annotate_only`   | Optional. Will only annotate the results on the files, won't create a check run.                                                                                   |
 
+### Action outputs
+
+After action execution it will return the test counts as output.
+
+```yml
+# ${{steps.{CHANGELOG_STEP_ID}.outputs.total}}
+```
+
+A full set list of possible output values for this action.
+
+| **Output**            | **Description**                                                                        |
+|-----------------------|----------------------------------------------------------------------------------------|
+| `outputs.total`       | The total number of test cases covered by this test-step.                              |
+| `outputs.passed`      | The number of passed test cases.                                                       |
+| `outputs.skipped`     | The number of skipped test cases.                                                      |
+| `outputs.failed`      | Then umber of failed test cases.                                                       |
+
 ## Sample 🖥️
 
 <div align="center">

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/main.ts b/src/main.ts
@@ -54,7 +54,9 @@ export async function run(): Promise<void> {
     ).length
     const passed = testResult.count - failed - testResult.skipped
 
+    core.setOutput('total', testResult.count)
     core.setOutput('passed', passed)
+    core.setOutput('skipped', testResult.skipped)
     core.setOutput('failed', failed)
 
     let title = 'No test results found!'