Merge pull request #32 from softwareengineerprogrammer/coverage-badge

Coverage badge NREL#22

Author: softwareengineerprogrammer

.github/workflows/github-actions.yml

@@ -122,6 +122,37 @@ jobs:
       run: >
         tox -e ${{ matrix.tox_env }} -v
 
+  coveralls:
+    name: Upload coverage to Coveralls
+    if: github.ref == 'refs/heads/main' # Prevent from running on PRs, tags
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          architecture: 'x64'
+      - name: install dependencies
+        run: |
+          python -mpip install --upgrade pip
+          python -mpip install --progress-bar=off -r ci/requirements.txt
+          virtualenv --version
+          pip --version
+          tox --version
+          pip list --format=freeze
+      - name: generate coverage report
+        env:
+          TOXPYTHON: '3.11'
+        run: |
+          tox -e py311
+
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/[email protected]
+
+
   deploy_docs:
     name: Deploy docs to GitHub Pages
     if: github.ref == 'refs/heads/main' # Prevent from running on PRs, tags

README.rst

@@ -20,6 +20,7 @@ Free software: `MIT license <LICENSE>`__
 
     * - tests
       - | |github-actions|
+      - | |coverage|
     * - package
       - | |commits-since|
 .. TODO add the following to package badge list once PyPy distribution enabled: |version| |wheel| |supported-versions| |supported-implementations|
@@ -55,7 +56,9 @@ Free software: `MIT license <LICENSE>`__
     :target: https://nrel.github.io/GEOPHIRES-X
     :alt: Documentation Status
 
-.. TODO coverage badge https://github.com/NREL/GEOPHIRES-Xx/issues/22
+.. |coverage| image:: https://coveralls.io/repos/github/softwareengineerprogrammer/GEOPHIRES-X/badge.svg
+    :target: https://coveralls.io/github/softwareengineerprogrammer/GEOPHIRES-X
+
 
 .. end-badges
 

tox.ini

@@ -28,7 +28,7 @@ basepython =
     py310: {env:TOXPYTHON:python3.10}
     py311: {env:TOXPYTHON:python3.11}
     py312: {env:TOXPYTHON:python3.12}
-    {bootstrap,clean,check,report,docs}: {env:TOXPYTHON:python3}
+    {bootstrap,clean,check,report,docs,coveralls}: {env:TOXPYTHON:python3}
 setenv =
     PYTHONPATH={toxinidir}/tests
     PYTHONUNBUFFERED=yes
@@ -74,7 +74,10 @@ commands =
     coverage html
 
 [testenv:clean]
-commands = coverage erase
+commands =
+    python setup.py clean
+    coverage erase
 skip_install = true
 deps =
+    setuptools
     coverage