Skip to content

ci: add docs check job#416

Merged
ValuedMammal merged 3 commits intobitcoindevkit:masterfrom
oleonardolima:ci/add-docs-check-job
Apr 2, 2026
Merged

ci: add docs check job#416
ValuedMammal merged 3 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
- ci(msrv): pin `icu_*` dependencies for 1.85.0 supported MSRV
- 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
Comment thread src/wallet/changeset.rs Outdated
@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 (826b19f) to head (8b4a51e).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #416   +/-   ##
=======================================
  Coverage   80.04%   80.04%           
=======================================
  Files          24       24           
  Lines        5336     5336           
  Branches      242      242           
=======================================
  Hits         4271     4271           
  Misses        987      987           
  Partials       78       78           
Flag Coverage Δ
rust 80.04% <ø> (ø)

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

Comment thread .github/workflows/cont_integration.yml Outdated
@oleonardolima oleonardolima force-pushed the ci/add-docs-check-job branch 2 times, most recently from 4c4fed7 to ff8c2a7 Compare April 2, 2026 13:56
@oleonardolima oleonardolima force-pushed the ci/add-docs-check-job branch from ff8c2a7 to 8b4a51e Compare April 2, 2026 14:47
@oleonardolima
Copy link
Copy Markdown
Contributor Author

I pushed 2f2346e to fix MSRV CI.

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 8b4a51e

@ValuedMammal
Copy link
Copy Markdown
Collaborator

Thank you!

@ValuedMammal
Copy link
Copy Markdown
Collaborator

ACK 8b4a51e

@ValuedMammal ValuedMammal merged commit fb7681a into bitcoindevkit:master Apr 2, 2026
18 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Review to Done in BDK Wallet Apr 2, 2026
@ValuedMammal ValuedMammal mentioned this pull request Apr 2, 2026
11 tasks
@oleonardolima oleonardolima deleted the ci/add-docs-check-job branch April 2, 2026 21:29
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

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants