Skip to content

bdk_testenv docs are not building on docs.rs #1627

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.

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

Closed
evanlinjin opened this issue Sep 26, 2024 · 4 comments
Closed

bdk_testenv docs are not building on docs.rs #1627

evanlinjin opened this issue Sep 26, 2024 · 4 comments
Assignees
Labels
bug Something isn't working release Release related issue or PR
Milestone

Comments

@evanlinjin
Copy link
Member

evanlinjin commented Sep 26, 2024

Describe the bug

https://docs.rs/bdk_testenv

In docs.rs sandboxed build environment, network access is blocked.

@riverKanies
Copy link
Contributor

pr for potential fix #1679

@notmandatory notmandatory added the release Release related issue or PR label Nov 20, 2024
notmandatory added a commit that referenced this issue Nov 21, 2024
…for docs.rs b…

9b48fd4 fix(testenv): disable downloads (bitcoind and electrsd) for docs.rs builds of crate testenv (River Kanies)

Pull request description:

  …uilds of crate testenv

  ### Description

  address this issue #1627
  where docs.rs build is failing for bdk_testenv crate

  original PR: #1679

  ### Notes to the reviewers

  I was not able to reproduce the build issue locally, so this will have to be tested live unless someone else can reproduce the build error https://docs.rs/crate/bdk_testenv/0.10.0/builds/1377651

  more details in this thread on discord https://discord.com/channels/753336465005608961/1265333904324427849/1304476756660719668

  #### Bugfixes:

  * [x] I'm linking the issue being fixed by this PR

ACKs for top commit:
  ValuedMammal:
    ACK 9b48fd4 but I guess we won't know for sure until we publish the crate
  notmandatory:
    ACK 9b48fd4

Tree-SHA512: fe4ad420f71530a279e1cf86af6e7bd59f381804a5c7c9636fa2aaa5592ff4e6fed668513831d7d63ed0a97152d685b187d50e906b21dbbb2180dedf5d28fad0
@notmandatory
Copy link
Member

Fixed by #1722

@riverKanies
Copy link
Contributor

Fixed by #1722

@notmandatory this won't be confirmed until docs.rs rebuilds bdk. Looks like that won't happen automatically until a new release, but looks like we can create an issue to request a rebuild https://github.com/rust-lang/docs.rs/issues/new?template=crate-build-failure.yaml

@notmandatory
Copy link
Member

We'll verify this solved the problem with the upcoming 1.0.0-beta.6, if it doesn't fix it for some reason we'll re-open this issue and fix it in a 1.0.1 patch release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working release Release related issue or PR
Projects
Archived in project
Development

No branches or pull requests

3 participants