Merge pull request #87 from cicirello/feat-workflow-summary

Add GitHub Actions workflow job summaries

Author: cicirello

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased] - 2022-10-21
 
 ### Added
+* Generate and output a GitHub Actions workflow job summary with the coverage percentages.
 
 ### Changed
 

src/jacoco_badge_generator/coverage_badges.py

@@ -58,6 +58,12 @@
 
 defaultColors = [ "#4c1", "#97ca00", "#a4a61d", "#dfb317", "#fe7d37", "#e05d44" ]
 
+markdownSummaryTemplate = """## JaCoCo Test Coverage Summary
+* __Coverage:__ {0:.3%}
+* __Branches:__ {1:.3%}
+* __Generated by:__ jacoco-badge-generator
+"""
+
 def generateBadge(covStr, color, badgeType="coverage") :
     """Generates the badge as a string. This includes calculating
     label width, etc, to support custom labels.
@@ -461,7 +467,8 @@ def coverageDictionary(cov, branches) :
 def set_action_outputs(output_pairs) :
     """Sets the GitHub Action outputs if running as a GitHub Action,
     and otherwise logs coverage percentages to terminal if running in
-    CLI mode.
+    CLI mode. Note that if the CLI mode is used within a GitHub Actions
+    workflow, it will be treated the same as GitHub Actions mode.
 
     Keyword arguments:
     output_pairs - Dictionary of outputs with values
@@ -474,6 +481,20 @@ def set_action_outputs(output_pairs) :
         for key, value in output_pairs.items() :
             print("{0}={1}".format(key, value))
 
+def add_workflow_job_summary(cov, branches) :
+    """When running as a GitHub Action, adds a job summary, and otherwise
+    does nothing when running in CLI mode. Note that if the CLI mode is
+    used within a GitHub Actions workflow, it will be treated the same as
+    GitHub Actions mode (no convenient way to tell the difference).
+
+    Keyword arguments:
+    cov - Coverage percentage
+    branches - Branches coverage percentage
+    """
+    if "GITHUB_STEP_SUMMARY" in os.environ :
+        with open(os.environ["GITHUB_STEP_SUMMARY"], "a") as f :
+            print(markdownSummaryTemplate.format(cov, branches), file=f)
+
 def main(jacocoCsvFile,
          badgesDirectory,
          coverageFilename,
@@ -611,3 +632,4 @@ def main(jacocoCsvFile,
                 json.dump(coverageDictionary(cov, branches), summaryFile, sort_keys=True)
 
         set_action_outputs({"coverage" : cov, "branches" : branches})
+        add_workflow_job_summary(cov, branches)