Skip to content

ci: publish Rust API docs to GitHub Pages on tag push - #1137

Merged
reez merged 1 commit into
bitcoindevkit:masterfrom
reez:ci-docs
Oct 12, 2026
Merged

reez merged 1 commit into
bitcoindevkit:masterfrom
reez:ci-docs

Conversation

@reez

@reez reez commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Adds a Publish Rust API Docs workflow that builds the docs with the existing build-docs.sh and deploys them with actions/deploy-pages on v* tag pushes (or manually for a given tag).

Removes deploy-docs.sh, makes just docs build-only for local previews, and updates the release template step.

Requires switching Settings → Pages → Source to "GitHub Actions" and allowing v* tags on the github-pages environment.

Notes to the reviewers

Removes a release step or having the right setup on local machine, publish automatically from CI on every release tag, and nobody force-pushes to gh-pages from a local machine.

Documentation

Changelog

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing
  • I've added exactly one changelog:* label
  • I've linked the relevant upstream docs or specs above

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

@thunderbiscuit thunderbiscuit left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ACK 5cd19e2.

@thunderbiscuit thunderbiscuit added this to the 3.2.0 milestone Oct 9, 2026
@reez
reez requested a review from a team as a code owner October 12, 2026 14:18
@reez

reez commented Oct 12, 2026

Copy link
Copy Markdown
Collaborator Author

rebased

@reez
reez merged commit fa62f0c into bitcoindevkit:master Oct 12, 2026
8 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in BDK-Bindings Oct 12, 2026
@reez
reez deleted the ci-docs branch October 12, 2026 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Publish Rust API docs from CI instead of a local script

2 participants