Add Github workflows for test, fmt, clippy, PR and Issue templates #3

tvpeter · 2025-11-14T15:22:47Z

Description

Fixes #2

This PR adds a PR template, issue template, workflows for testing, fmt, and clippy.

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

oleonardolima

Overall looks good, I just left a few comments.

I think we can only commit the Cargo.lock once it's final, and moved to corepc repository. WDYT ?

oleonardolima · 2025-11-18T13:31:31Z

.github/workflows/cont_integration.yml

+      - name: Generate cache key
+        shell: bash
+        run: echo "${{ matrix.rust }} ${{ matrix.features }}" | tee .cache_key
+
+      - name: Cache cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-${{ matrix.rust }}-cargo-registry-${{ hashFiles('.cache_key') }}-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-${{ matrix.rust }}-cargo-index-${{ hashFiles('.cache_key') }}-${{ hashFiles('**/Cargo.lock') }}


I think it's a better idea to follow the same CI approach as bdk_wallet, and use the actions-rust-lang/setup-rust-toolchain@v1 and it can handle all the cache and rust toolchain.

The idea was to follow the same CI as corepc ?

The idea was to follow the same CI as corepc ?

No, it wasn't. I used the approach we used in bdk-cli

Ah, got it. I'll test the CI on my fork and see how it goes.

I don't mean to bikeshed on this PR, and we can update the CI to follow either bdk-wallet or bdk ones in a follow-up (if this already unblocks you for upcoming PRs).

@tvpeter Oh, you pushed a new commit as I was reviewing 😁. Let me know again when it's ready for review or my suggestions are not applicable.

@tvpeter Oh, you pushed a new commit as I was reviewing 😁. Let me know again when it's ready for review or my suggestions are not applicable.

Oh apologies, I was addressing your yesterday's comments. Let me update to include the latest comments and will re-request a review. Thank you

oleonardolima · 2025-11-18T13:33:48Z

Cargo.toml


+[features]
+default = [ "v30" ]
+v30 = [ ]


nit: you can follow the same way as corepc: 30_0

- harmonize all actions to use actions-rust-lang/ setup-rust-toolchain with auto-caching

oleonardolima · 2025-11-19T17:48:31Z

.github/workflows/cont_integration.yml

+      - name: Install Bitcoin Core 27.0
+        run: |
+          wget https://bitcoincore.org/bin/bitcoin-core-30.0/bitcoin-30.0-x86_64-linux-gnu.tar.gz
+          tar xzf bitcoin-30.0-x86_64-linux-gnu.tar.gz
+          sudo install -m 0755 -o root -g root -t /usr/local/bin bitcoin-30.0/bin/*
+      
+      - name: Start Bitcoin Core (regtest)
+        run: |
+          mkdir -p ~/.bitcoin
+          bitcoind -regtest -daemon -rpcuser=test -rpcpassword=test -rpcport=18443
+          sleep 5
+      
+      - name: Run integration tests
+        run: cargo test ${{ matrix.features }} --test integration -- --ignored --test-threads=1
+        env:
+          BITCOIN_RPC_URL: http://localhost:18443
+          BITCOIN_RPC_USER: bitcoin
+          BITCOIN_RPC_PASS: bitcoin


I don't think this is needed, as ideally we should use the corepc-node (prev. bitcoind) for the integration tests, and it handles the download and wrapping (such as in bdk_testenv).

Can be done in a follow-up, let's get an initial CI running first :)

oleonardolima · 2025-11-19T17:51:23Z

Cargo.toml

-name = "bdk-rpc-client"
+name = "bdk_rpc_client"
 version = "0.1.0"
 edition = "2024"


Suggested change

edition = "2024"

edition = "2024"

rust-version = "1.85.0"

homepage = "https://bitcoindevkit.org"

repository = "https://github.com/bitcoindevkit/bdk_rpc_client"

documentation = "https://docs.rs/bdk_rpc_client"

description = "A minimal production-ready bitcoind RPC client for Bitcoin Dev Kit."

license = "MIT OR Apache-2.0"

readme = "README.md"

It's just a suggestion, can be done in a follow-up, and the description could be different too (if you have any other idea).

Missing authors field.

oleonardolima · 2025-11-19T17:52:46Z

I've tested the CI in my fork (see https://github.com/oleonardolima/bdk-rpc-client/actions/runs/19510871935/job/55850429271) and it worked just fine.

tvpeter · 2025-11-20T22:18:56Z

I think the only think that we might not need is setting up a bitcoind on CI, but can be updated in a follow-up too.

Yesterday's update removed the entire setup for Bitcoind. Please verify.

luisschwab · 2025-11-20T22:21:50Z

We should be using pinned hashes, add zizmor, cargo-audit and dependabot.

See https://github.com/luisschwab/koerier/tree/master/.github for an example on these.

oleonardolima · 2025-11-20T22:36:34Z

I think the only think that we might not need is setting up a bitcoind on CI, but can be updated in a follow-up too.

Yesterday's update removed the entire setup for Bitcoind. Please verify.

Oh, yes! All good now 🚀

- add audit, zizmor workflows and dependabot

tvpeter · 2025-11-21T05:32:52Z

We should be using pinned hashes, add zizmor, cargo-audit and dependabot.

See https://github.com/luisschwab/koerier/tree/master/.github for an example on these.

I have included zizmor, audit and dependabot now.

tvpeter added 2 commits November 14, 2025 12:26

add pull request template and changelog

8c70671

add integration tests workflow

ed39a3e

tvpeter requested a review from ValuedMammal November 14, 2025 15:23

tvpeter changed the title ~~Add Github workflow for test, fmt, clippy and PR template~~ Add Github workflows for test, fmt, clippy, PR and Issue templates Nov 17, 2025

tvpeter requested a review from oleonardolima November 17, 2025 04:56

tvpeter force-pushed the feat/git-workflow branch from 1a163f9 to 30ca521 Compare November 17, 2025 05:04

feat(git-workflow): add issues template

6e9730c

tvpeter force-pushed the feat/git-workflow branch from 30ca521 to 6e9730c Compare November 17, 2025 05:12

oleonardolima reviewed Nov 18, 2025

View reviewed changes

oleonardolima assigned tvpeter Nov 18, 2025

oleonardolima added this to BDK Chain Nov 18, 2025

oleonardolima moved this to Needs Review in BDK Chain Nov 18, 2025

tvpeter mentioned this pull request Nov 18, 2025

Add Blockchain RPC methods #5

Open

5 tasks

feat(git-workflow): harmonize toolchain

748456e

- harmonize all actions to use actions-rust-lang/ setup-rust-toolchain with auto-caching

oleonardolima reviewed Nov 19, 2025

View reviewed changes

tvpeter added 2 commits November 19, 2025 19:10

improve lib meta data

6e940f7

remove integration test workflow

cbba98c

tvpeter requested a review from oleonardolima November 19, 2025 18:15

oleonardolima mentioned this pull request Nov 20, 2025

feat: add justfile #6

Open

This comment was marked as outdated.

Sign in to view

feat(git-workflow): add audit, zizmor & dependabot

c73a37d

- add audit, zizmor workflows and dependabot

-edition = "2024"
+edition = "2024"
+rust-version = "1.85.0"
+homepage = "https://bitcoindevkit.org"
+repository = "https://github.com/bitcoindevkit/bdk_rpc_client"
+documentation = "https://docs.rs/bdk_rpc_client"
+description = "A minimal production-ready bitcoind RPC client for Bitcoin Dev Kit."
+license = "MIT OR Apache-2.0"
+readme = "README.md"

Add Github workflows for test, fmt, clippy, PR and Issue templates #3

Are you sure you want to change the base?

Add Github workflows for test, fmt, clippy, PR and Issue templates #3

Conversation

tvpeter commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklists

All Submissions:

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oleonardolima Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oleonardolima commented Nov 19, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

tvpeter commented Nov 20, 2025

Uh oh!

luisschwab commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oleonardolima commented Nov 20, 2025

Uh oh!

tvpeter commented Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tvpeter commented Nov 14, 2025 •

edited

Loading

oleonardolima Nov 19, 2025 •

edited

Loading

luisschwab commented Nov 20, 2025 •

edited

Loading