From 6b0bb8653999d6e706f3c7d60fa6170a92d2ef3a Mon Sep 17 00:00:00 2001 From: nymius <155548262+nymius@users.noreply.github.com> Date: Wed, 2 Jul 2025 16:21:36 -0300 Subject: [PATCH 1/2] ci: generate coverage report and upload to coveralls --- .github/workflows/coverage.yml | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml index 1cb2050..75b90b4 100644 --- a/.github/workflows/coverage.yml +++ b/.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 From 022a8d7b3c92eaef4bb2aaccc15e1a49722fbe95 Mon Sep 17 00:00:00 2001 From: nymius <155548262+nymius@users.noreply.github.com> Date: Tue, 8 Jul 2025 21:16:39 -0300 Subject: [PATCH 2/2] doc(README): add coveralls badge --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 42ac380..64a7734 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ # `bdk-sp` +
+

+ An experimental crate to research the implementation of silent payment tools in BDK. +

+ +

+ +

+
+ > [!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].