Skip to content

ci: add docs check job#416

Open
oleonardolima wants to merge 2 commits intobitcoindevkit:masterfrom
oleonardolima:ci/add-docs-check-job
Open

ci: add docs check job#416
oleonardolima wants to merge 2 commits intobitcoindevkit:masterfrom
oleonardolima:ci/add-docs-check-job

Conversation

@oleonardolima
Copy link
Copy Markdown
Contributor

@oleonardolima oleonardolima commented Mar 23, 2026

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

- fix(docs): use correct `intra_doc_links`.

Checklists

All Submissions:

@oleonardolima oleonardolima self-assigned this Mar 23, 2026
@oleonardolima oleonardolima added the documentation Improvements or additions to documentation label Mar 23, 2026
@oleonardolima oleonardolima added the github_actions Pull requests that update GitHub Actions code label Mar 23, 2026
@oleonardolima oleonardolima moved this to Needs Review in BDK Wallet Mar 23, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.04%. Comparing base (4d4adae) to head (4d2e398).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #416      +/-   ##
==========================================
+ Coverage   79.93%   80.04%   +0.10%     
==========================================
  Files          24       24              
  Lines        5287     5336      +49     
  Branches      241      242       +1     
==========================================
+ Hits         4226     4271      +45     
- Misses        984      987       +3     
- Partials       77       78       +1     
Flag Coverage Δ
rust 80.04% <ø> (+0.10%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ValuedMammal ValuedMammal added this to the Wallet 3.1.0 milestone Mar 24, 2026
@oleonardolima oleonardolima force-pushed the ci/add-docs-check-job branch from 0382434 to 4d2e398 Compare March 25, 2026 14:49
Copy link
Copy Markdown
Member

@luisschwab luisschwab left a comment

Choose a reason for hiding this comment

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

ACK 4d2e398

Copy link
Copy Markdown
Contributor

@Dmenec Dmenec left a comment

Choose a reason for hiding this comment

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

tACK 4d2e398

Copy link
Copy Markdown
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 4d2e398

with:
cache: true
- name: Check docs
run: RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We should probably use --all-features here wdyt?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

Status: Needs Review

Development

Successfully merging this pull request may close these issues.

4 participants