Output total percentage coverage (#47)

* Output total percentage coverage * Consistent naming Co-authored-by: Zennon Gosalvez <[email protected]>
zgosalvez · Dec 30, 2022 · 3da0a76 · 3da0a76
1 parent 369eb1e
commit 3da0a76
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ For more information on these inputs, see the [Workflow syntax for GitHub Action
 - `title-prefix`: A prefix before the title "LCOV of commit..." Optional. Default: ``
 
 ### Outputs
-None.
+- `total-coverage`: The total coverage from scanned files.
 
 Sample comment:
 ![Screenshot](assets/comment.png)
@@ -57,4 +57,4 @@ jobs:
 This is used in my opinionated [GitHub Actions: Flutter Workflows](https://github.com/zgosalvez/github-actions-flutter-workflows) repository along with other actions for a complete end-to-end DevOps experience.
 
 ## License
-The scripts and documentation in this project are released under the [MIT License](LICENSE)
+The scripts and documentation in this project are released under the [MIT License](LICENSE)
diff --git a/action.yml b/action.yml
@@ -19,10 +19,14 @@ inputs:
   title-prefix:
     description: 'A prefix before the title "LCOV of commit..." Optional. Default: ``'
     required: false
+outputs:
+  total-coverage:
+      description: 'The total coverage from scanned files.'
+
 runs:
   using: 'node16'
   main: 'dist/main/index.js'
   post: 'dist/post/index.js'
 branding:
   icon: umbrella
-  color: purple
+  color: purple
diff --git a/dist/main/index.js b/dist/main/index.js
diff --git a/dist/main/index.js.map b/dist/main/index.js.map
diff --git a/src/main.js b/src/main.js
@@ -52,6 +52,8 @@ async function run() {
       core.info("Note: This could happen even if github-token was provided in workflow file. It could be because your github token does not have permissions for commenting in target repo.")
     }
 
+    core.setOutput("total-coverage", totalCoverage);
+
     if (isFailure) {
       throw Error(errorMessage);
     }