Skip to content

ci: check-docs for all workspace packages#2158

Merged
oleonardolima merged 2 commits intobitcoindevkit:masterfrom
shinigami-777:check-docs
Mar 26, 2026
Merged

ci: check-docs for all workspace packages#2158
oleonardolima merged 2 commits intobitcoindevkit:masterfrom
shinigami-777:check-docs

Conversation

@shinigami-777
Copy link
Copy Markdown
Contributor

@shinigami-777 shinigami-777 commented Mar 15, 2026 •
edited by oleonardolima
Loading

fixes #2152

Description

This PR adds new CI job check-docs to validate that documentation builds for all workspace packages, also adds a new justfile recipe just doc.

It also fixes the existing errors in bdk_chain and bdk_core.

Changelog notice

### Added

- ci: add new `check-docs` job.

### Changed

- fix(docs): in `keychain_txout.rs` and `spk_client.rs`

Checklists

All Submissions:

New Features:

  • I've added tests for the new feature
  • I've added docs for the new feature

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

@shinigami-777 shinigami-777 changed the title Check docs ci: Check-docs for all workspace packages Mar 15, 2026
@evanlinjin
Copy link
Copy Markdown
Member

evanlinjin commented Mar 16, 2026

Thanks for this work.

I think it also makes sense to also include the documentation fixes in this PR (as a separate commit).

@ValuedMammal
Copy link
Copy Markdown
Collaborator

ValuedMammal commented Mar 16, 2026

@shinigami-777 Can you add a commit addressing the check-docs failures? I recommend removing the redundant explicit link targets in keychain_txout.rs for types that are already in scope (i.e. bitcoin::Script). Then in spk_client.rs update the docs with a valid link to the KeychainTxOutIndex type.

@shinigami-777
Copy link
Copy Markdown
Contributor Author

shinigami-777 commented Mar 16, 2026

Thanks for this work.

I think it also makes sense to also include the documentation fixes in this PR (as a separate commit).

I have added some doc changes to the CONTRIBUTING.md in this commit.

@shinigami-777
Copy link
Copy Markdown
Contributor Author

shinigami-777 commented Mar 16, 2026

Updated keychain_txout.rs and spk_client.rs. Now all doc checks are successful.

@ValuedMammal ValuedMammal added documentation Improvements or additions to documentation tests github_actions Pull requests that update GitHub Actions code labels Mar 16, 2026
@ValuedMammal ValuedMammal moved this to Needs Review in BDK Chain Mar 16, 2026
@ValuedMammal ValuedMammal linked an issue Mar 16, 2026 that may be closed by this pull request
Check cargo rustdoc for all workspace members #2152
Closed
10 tasks
@oleonardolima oleonardolima added this to the Chain 0.24.0 milestone Mar 16, 2026
oleonardolima
oleonardolima reviewed Mar 16, 2026
View reviewed changes
Copy link
Copy Markdown
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.

Thanks for working on this one!

I left some comments as I don't see use for a new check-docs.sh file we should probably just call the cargo commands directly. Let's see what other thinks about it.

Also, you could probably squash it into two commits, something like this:

  • ci: add new check-docs job and recipe in justfile
  • fix(docs): in keychain_txout.rs and spk_client.rs

Comment thread justfile
Comment thread ci/check-docs.sh Outdated
Comment thread crates/core/src/spk_client.rs Outdated
Comment thread .github/workflows/cont_integration.yml Outdated
@shinigami-777
Copy link
Copy Markdown
Contributor Author

shinigami-777 commented Mar 18, 2026

@oleonardolima Thanks for reviewing. I have made the changes and squashed them in 2 commits: c4b8e93 and 1d1e985

oleonardolima
oleonardolima approved these changes Mar 19, 2026
View reviewed changes
Copy link
Copy Markdown
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 1d1e985

@oleonardolima oleonardolima mentioned this pull request Mar 23, 2026
Merged
3 tasks
@oleonardolima oleonardolima changed the title ci: Check-docs for all workspace packages ci: check-docs for all workspace packages Mar 25, 2026
@oleonardolima
Copy link
Copy Markdown
Collaborator

oleonardolima commented Mar 26, 2026

I fixed a trailing whitespace in 19d1269.

oleonardolima
oleonardolima approved these changes Mar 26, 2026
View reviewed changes
Copy link
Copy Markdown
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.

ACK 9c8b564

@oleonardolima oleonardolima merged commit b203e31 into bitcoindevkit:master Mar 26, 2026
18 checks passed
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Chain Mar 26, 2026
ValuedMammal added a commit to bitcoindevkit/bdk_wallet that referenced this pull request Apr 2, 2026
@ValuedMammal
Merge #416: ci: add docs check job
fb7681a 
8b4a51e fix(docs): use correct `intra-doc-links` (Leonardo Lima)
dbf3d8e ci: add job to check `cargo doc` (Leonardo Lima)
2f2346e fix(ci): pin required `icu_*` dependencies (Leonardo Lima)

Pull request description:

  ### Description

  As we are adding in bitcoindevkit/bdk#2158, this PR adds a new CI job and justfile recipe to check for the documentation.

  ### Notes to the reviewers

  ### Changelog notice

  ```
  ### Added

  - ci: add new `docs_check` job to check for any error or warning in docs.

  ### Changed
  - ci(msrv): pin `icu_*` dependencies for 1.85.0 supported MSRV
  - fix(docs): use correct `intra_doc_links`.
  ```

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `just p` before pushing

ACKs for top commit:
  ValuedMammal:
    ACK 8b4a51e
  luisschwab:
    ACK 8b4a51e

Tree-SHA512: 9fbe0190776c348867b13c06ec6f2c272fe5ee41995f3ff5898b7d149affc5e602d8afa06669702af7a04ad15bb2a7c940110830cd7e11116c4974ceda423877
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

@evanlinjin evanlinjin Awaiting requested review from evanlinjin evanlinjin is a code owner

Assignees

@shinigami-777 shinigami-777

Labels

documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code tests

Projects

BDK Chain
Status: Done

Milestone

Chain 0.24.0

Development

Successfully merging this pull request may close these issues.

Check cargo rustdoc for all workspace members

4 participants

@shinigami-777 @evanlinjin @ValuedMammal @oleonardolima