Add coverage badge to README

.github/workflows/tests.yml

@@ -34,6 +34,7 @@ jobs:
       - name: Run unit tests
         run: test/run_tests.bash
       - name: Pytest coverage comment
+        id: coverageComment
         uses: MishaKav/pytest-coverage-comment@main
         with:
           pytest-coverage-path: ./test/results/pytest-coverage.txt
@@ -42,6 +43,16 @@ jobs:
           coverage-path-prefix: src/pyroboplan/
         # This will break on PRs from forks
         if: ${{ !github.event.pull_request.head.repo.fork }}
+      - name: Create coverage badge
+        uses: schneegans/[email protected]
+        with:
+          auth: ${{ secrets.COVERAGE_GIST_SECRET }}
+          gistID: e5e091166a18c68b26338793917d3bab
+          filename: pyroboplan-test-coverage.json
+          label: Coverage Report
+          message: ${{ steps.coverageComment.outputs.coverage }}
+          color: ${{ steps.coverageComment.outputs.color }}
+          namedLogo: python
       - name: Upload test results
         uses: actions/upload-artifact@v3
         with:

README.md

@@ -2,6 +2,7 @@
 
 [![PyRoboPlan Tests](https://github.com/sea-bass/pyroboplan/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/sea-bass/pyroboplan/actions/workflows/tests.yml)
 [![Documentation Status](https://readthedocs.org/projects/pyroboplan/badge/?version=latest)](https://pyrobosim.readthedocs.io/en/latest/?badge=latest)
+![Coverage Status](https://img.shields.io/endpoint?url=https://gist.github.com/sea-bass/e5e091166a18c68b26338793917d3bab#file-pyroboplan-test-coverage-json)]
 
 Educational Python library for manipulator motion planning.