feat: Custom code coverage summary title (#31)

Closes #30
insightsengineering · Oct 18, 2023 · e9f4411 · e9f4411
1 parent 36a0fea
commit e9f4411
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -24,27 +24,31 @@ jobs:
             diff: false
             diff-branch: main
             diff-storage: _xml_coverage_reports
+            coverage-summary-title: "Code Coverage Summary (test-branch.xml)"
           - path: test-missing-lines.xml
             threshold: 50
             fail: false
             publish: true
             diff: false
             diff-branch: main
             diff-storage: _xml_coverage_reports
+            coverage-summary-title: "Code Coverage Summary (test-missing-lines.xml)"
           - path: test-no-branch.xml
             threshold: 90
             fail: true
             publish: true
             diff: true
             diff-branch: main
             diff-storage: _xml_coverage_reports_1
+            coverage-summary-title: "Code Coverage Summary (test-no-branch.xml)"
           - path: test-python.xml
             threshold: 90
             fail: false
             publish: false
             diff: true
             diff-branch: main
             diff-storage: _xml_coverage_reports_2
+            coverage-summary-title: "Code Coverage Summary (test-python.xml)"
     steps:
       - name: Checkout Code 🛎
         uses: actions/checkout@v3
@@ -59,3 +63,4 @@ jobs:
           diff: ${{ matrix.reports.diff }}
           diff-branch: ${{ matrix.reports.diff-branch }}
           diff-storage: ${{ matrix.reports.diff-storage }}
+          coverage-summary-title: ${{ matrix.reports.coverage-summary-title}}
diff --git a/README.md b/README.md
@@ -81,6 +81,14 @@ Insights Engineering
 
   _Default_: `_xml_coverage_reports`
 
+* `coverage-summary-title`:
+
+  _Description_: Title for the code coverage summary in the Pull Request comment.
+
+  _Required_: `false`
+
+  _Default_: `Code Coverage Summary`
+
 * `coverage-reduction-failure`:
 
   _Description_: Fail the action if code coverage decreased compared to the `diff-branch` is decreased.
@@ -177,6 +185,9 @@ jobs:
           # `diff-branch` are stored.
           # Branch is created if it doesn't already exist'.
           diff-storage: _xml_coverage_reports
+          # A custom title that can be added to the code
+          # coverage summary in the PR comment.
+          coverage-summary-title: "Code Coverage Summary"
 ```
 
 An example of the output of the action can be seen below:

diff --git a/action.yml b/action.yml
@@ -37,6 +37,10 @@ inputs:
     description: Branch where coverage reports are stored for diff purposes.
     required: false
     default: _xml_coverage_reports
+  coverage-summary-title:
+    description: Title for the code coverage summary in the Pull Request comment.
+    required: false
+    default: "Code Coverage Summary"
   coverage-reduction-failure:
     description: Fail the action if code coverage decreased compared to the `diff-branch` is decreased.
     required: false
@@ -224,7 +228,7 @@ runs:
           echo -e "🧪 Test coverage: ${{ steps.coverage_percent.outputs.coverage_total }}%\n\n" > .coverage-output.final
         }
         fi
-        echo -e "## Code Coverage Summary\n" >> .coverage-output.final
+        echo -e "## ${{ inputs.coverage-summary-title }}\n" >> .coverage-output.final
         if [[ "${{ inputs.togglable-report }}" == "true" ]]
         then {
           echo -e "<details>\n\n" >> .coverage-output.final