Skip to content

Commit

Permalink
Add coverage reporting to GitHub Actions workflow; update README badges.
Browse files Browse the repository at this point in the history
  • Loading branch information
lapets committed Nov 8, 2023
1 parent cc5ecb4 commit a768be0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
8 changes: 8 additions & 0 deletions .github/workflows/lint-test-cover-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ jobs:
python -m pylint tinynmc # Check against linting rules.
python -m pytest # Run tests.
python src/tinynmc/tinynmc.py -v # Run tests via execution.
- name: Publish coverage results.
run: |
pip install -U .[coveralls]
python -m coveralls --service=github # Submit to coveralls.
if: matrix.python-version == '3.11'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
- name: Test auto-generation of documentation.
run: |
pip install -U .[docs]
Expand Down
6 changes: 5 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ tinynmc

Minimal pure-Python implementation of a secure multi-party computation (MPC) protocol for evaluating arithmetic sum-of-products expressions via a non-interactive computation phase.

|pypi| |readthedocs| |actions|
|pypi| |readthedocs| |actions| |coveralls|

.. |pypi| image:: https://badge.fury.io/py/tinynmc.svg
:target: https://badge.fury.io/py/tinynmc
Expand All @@ -18,6 +18,10 @@ Minimal pure-Python implementation of a secure multi-party computation (MPC) pro
:target: https://github.com/nillion-oss/tinynmc/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.

.. |coveralls| image:: https://coveralls.io/repos/github/nillion-oss/tinynmc/badge.svg?branch=main
:target: https://coveralls.io/github/nillion-oss/tinynmc?branch=main
:alt: Coveralls test coverage summary.

Installation and Usage
----------------------

Expand Down

0 comments on commit a768be0

Please sign in to comment.