Configure GitHub action for displaying code coverage (#43)

Author: AustinCullar

.github/workflows/astro-testing.yml

@@ -11,6 +11,7 @@ on:
 
 permissions:
   contents: read
+  pull-requests: write
 
 jobs:
   build:
@@ -23,19 +24,42 @@ jobs:
       uses: actions/setup-python@v3
       with:
         python-version: "3.12"
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         pip install -e .
+
     - name: Lint with flake8
       run: |
-        # Run flake8 using the .flake8 config file
         flake8
-    - name: Run pytest under coverage
+
+    # run pytest under coverage and write results to an xml file
+    - name: Run pytest
       run: |
         coverage run -m pytest
+        coverage xml
+
+    # process coverage report into markdown format
     - name: Generate coverage report
-      run: |
-        coverage report -m
+      uses: irongut/CodeCoverageSummary@v1.3.0
+      with:
+        filename: coverage.xml
+        badge: true
+        fail_below_min: true
+        format: markdown
+        hide_branch_rate: false
+        hide_complexity: true
+        indicators: true
+        output: both
+        thresholds: '70 90'
+
+    # post PR comment with code coverage information
+    - name: Add Coverage PR Comment
+      uses: marocchino/sticky-pull-request-comment@v2
+      if: github.event_name == 'pull_request'
+      with:
+        recreate: true
+        path: code-coverage-results.md