Merge pull request #16 from 'ci/update-coverage-job'

- generate coverage report and upload to coveralls
- add coveralls badge

Author: nymius

.github/workflows/coverage.yml

@@ -1,22 +1,23 @@
 name: Code Coverage
 
-on:
-  push:
-    branches: [ "develop" ]
-  pull_request:
+on: [push, pull_request]
 
 env:
   CARGO_TERM_COLOR: always
 
+permissions: {}
+
 jobs:
   coverage:
     name: Code Coverage
     runs-on: ubuntu-latest
-    env:
-      CARGO_INCREMENTAL: 0
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Install lcov tools
+        run: sudo apt-get install lcov -y
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@v1
         with:
@@ -26,5 +27,18 @@ jobs:
         uses: Swatinem/rust-cache@v2.7.8
       - name: Install cargo-llvm-cov
         run: if [[ ! -e ~/.cargo/bin/cargo-llvm-cov ]]; then cargo install cargo-llvm-cov; fi
+      - name: Make coverage directory
+        run: mkdir coverage
       - name: Test and report coverage
-        run: cargo +nightly llvm-cov -q --doctests --branch --workspace --ignore-filename-regex "example-crates/*"
+        run: cargo +nightly llvm-cov -q --doctests --branch --all --ignore-filename-regex "example-crates/*" --all-features --lcov --output-path ./coverage/lcov.info
+      - name: Generate HTML coverage report
+        run: genhtml -o coverage-report.html --ignore-errors unmapped ./coverage/lcov.info
+      - name: Coveralls upload
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage-report.html

README.md

@@ -1,11 +1,18 @@
 # `bdk-sp`
 
+<div align="center">
+  <p>
+    <strong>An experimental crate to research the implementation of silent payment tools in BDK.</strong>
+  </p>
+
+  <p>
+    <a href="https://coveralls.io/github/bitcoindevkit/bdk-sp?branch=master"><img src="https://coveralls.io/repos/github/bitcoindevkit/bdk-sp/badge.svg?branch=master"/></a>
+  </p>
+</div>
+
 > [!WARNING]
 > Work in progress. Not recommended for use with bitcoin mainnet.
 
-This is an experimental crate to research the implementation of silent payment
-tools in BDK.
-
 ![execution flow enabled by this crate](../media/sp_flow.gif?raw=true)
 
 This is a second iteration of the work initiated in [rust-bip352].