Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Nov 24, 2025
Merged

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

merged 8 commits into from
Nov 24, 2025

Conversation

@tvpeter
Copy link
Collaborator

@tvpeter tvpeter commented Nov 14, 2025 •
edited
Loading

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

@tvpeter tvpeter requested a review from ValuedMammal November 14, 2025 15:23
@tvpeter 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
oleonardolima
oleonardolima reviewed Nov 18, 2025
View reviewed changes
Copy link
Collaborator

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 oleonardolima moved this to Needs Review in BDK Chain Nov 18, 2025
@tvpeter tvpeter mentioned this pull request Nov 18, 2025
Open
5 tasks
@tvpeter
feat(git-workflow): harmonize toolchain
748456e 
- harmonize all actions to use actions-rust-lang/
setup-rust-toolchain with auto-caching
oleonardolima
oleonardolima reviewed Nov 19, 2025
View reviewed changes
@oleonardolima
Copy link
Collaborator

oleonardolima commented Nov 19, 2025

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.

@oleonardolima oleonardolima mentioned this pull request Nov 20, 2025
Closed
oleonardolima

This comment was marked as outdated.

Sign in to view

@tvpeter
Copy link
Collaborator Author

tvpeter commented Nov 20, 2025

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
Copy link
Member

luisschwab commented Nov 20, 2025 •
edited
Loading

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
Copy link
Collaborator

oleonardolima commented Nov 20, 2025

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 🚀

@tvpeter
Copy link
Collaborator Author

tvpeter commented Nov 21, 2025

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.

oleonardolima
oleonardolima reviewed Nov 24, 2025
View reviewed changes
Copy link
Collaborator

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, it's working on my fork, but I left some other nits that we could address here too.

@oleonardolima oleonardolima mentioned this pull request Nov 24, 2025
Merged
@tvpeter
feat(git-workflow): add audit, zizmor & dependabot
10dccdb 
- add audit, zizmor workflows and dependabot
- set MSRV to 1.75.0
@oleonardolima oleonardolima self-requested a review November 24, 2025 21:11
oleonardolima
oleonardolima approved these changes Nov 24, 2025
View reviewed changes
Copy link
Collaborator

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK 1616a38 ; I didn't test the new commits on my CI fork, as I'm on the move now.

@tvpeter Thanks for your work and addressing the suggestions, I think all the remaining nits we can cover in a follow-up.

Overall looks good to me, only need another ACK from VM and it's good to go.

.github/workflows/audit.yml
Comment on lines +35 to +41
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Cache cargo registry/index/target
uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1
with:
cache-on-failure: true
Copy link
Collaborator

@oleonardolima oleonardolima Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: as a follow-up, we can probably use the other toolchain action so we don't need Swatinem/rust-cache, but don't want to keep bikeshedding on this one.

ValuedMammal
ValuedMammal approved these changes Nov 24, 2025
View reviewed changes
Copy link
Collaborator

@ValuedMammal ValuedMammal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 1616a38

@ValuedMammal
Copy link
Collaborator

ValuedMammal commented Nov 24, 2025

reACK 89aa6f0

oleonardolima
oleonardolima reviewed Nov 24, 2025
View reviewed changes
Copy link
Collaborator

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK 89aa6f0

@tvpeter tvpeter merged commit 911dd33 into bitcoindevkit:master Nov 24, 2025
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Chain Nov 24, 2025
@oleonardolima oleonardolima mentioned this pull request Nov 24, 2025
Open
tvpeter added a commit that referenced this pull request Nov 25, 2025
@tvpeter
Merge #10: feat: add a justfile
956b717 
af6d056 feat: add a justfile (Luis Schwab)

Pull request description:

  This PR adds a minimal justfile (stolen from bdk_wallet).

ACKs for top commit:
  ValuedMammal:
    ACK af6d056
  oleonardolima:
    ACK af6d056 ; but depends on #3
  tvpeter:
    tACK af6d056

Tree-SHA512: 813caeade38c57c83e8b2123bf8f9c7ffcda5a900e14334b67f277b2ee035f5f01f90f85661b5b6d70508530258e8043510abc0819012f74ed4ffd9c27b56b98
@tvpeter tvpeter mentioned this pull request Nov 25, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oleonardolima oleonardolima oleonardolima approved these changes

@luisschwab luisschwab luisschwab left review comments

@ValuedMammal ValuedMammal ValuedMammal approved these changes

Assignees

@tvpeter tvpeter

Labels

None yet

Projects

BDK Chain
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add Github Workflow for PRs and Issues

4 participants

@tvpeter @oleonardolima @luisschwab @ValuedMammal