Skip to content

Conversation

@notmandatory
Copy link
Member

@notmandatory notmandatory commented Mar 17, 2025

Description

I removed the nightly_docs workflow since it's not needed. The latest published bdk crate docs can be found on docs.rs.

Notes to the reviewers

We early in the project life we published nightly docs since the API was changing often and releases were infrequent. But now that the api is more stable and we make regular releases nightly docs aren't needed.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

@notmandatory
Copy link
Member Author

@ValuedMammal I think this fixes the permissions issue for #1847, reverts and replaces #1895.

@notmandatory notmandatory linked an issue Mar 17, 2025 that may be closed by this pull request
@notmandatory notmandatory moved this to Needs Review in BDK Chain Mar 17, 2025
@notmandatory notmandatory moved this to Needs Review in BDK Wallet Mar 17, 2025
@notmandatory notmandatory added this to the 1.2.0 milestone Mar 17, 2025
@notmandatory notmandatory self-assigned this Mar 17, 2025
@notmandatory
Copy link
Member Author

Do we even still need bdk nightly docs published to the web site? We already have links there to the docs.rs pages which are what most users should be using. If not then I'll change this PR to remove the nightly_docs.yml workflow.

@notmandatory notmandatory moved this from Needs Review to In Progress in BDK Chain Mar 17, 2025
@notmandatory notmandatory moved this from Needs Review to In Progress in BDK Wallet Mar 17, 2025
@Musab1258
Copy link
Contributor

Musab1258 commented Mar 18, 2025

Member

@notmandatory, On this, the nightly doc are not linked on the main page of the website, and I had to search for it before I found it.

I guess this is the link right: https://bitcoindevkit.org/docs-rs/bdk/nightly/latest/bdk_wallet/

@thunderbiscuit
Copy link
Member

I don't personally think we need the nightly docs published on the website.

@notmandatory notmandatory changed the title ci: fix nightly_docs workflow, use org Github App ci: remove not needed nightly_docs workflow Mar 18, 2025
@notmandatory
Copy link
Member Author

I've update this PR to remove the unneeded nightly_docs workflow.

@notmandatory notmandatory moved this from In Progress to Needs Review in BDK Chain Mar 18, 2025
@notmandatory notmandatory moved this from In Progress to Needs Review in BDK Wallet Mar 18, 2025
Copy link
Member

@thunderbiscuit thunderbiscuit left a comment

Choose a reason for hiding this comment

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

ACK 2cba473.

@notmandatory notmandatory merged commit 3b6441a into bitcoindevkit:master Mar 19, 2025
21 checks passed
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Wallet Mar 19, 2025
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Chain Mar 19, 2025
@notmandatory notmandatory deleted the ci/fix_nightly_docs branch May 26, 2025 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project
Archived in project

Development

Successfully merging this pull request may close these issues.

CI: Publish docs job fails with "Permission denied"

4 participants