Repository navigation
ci: publish Rust API docs to GitHub Pages on tag push - #1137
Merged
Merged
Conversation
Collaborator
Author
|
rebased |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-pagesfrom a local machine.Documentation
bdk_walletbitcoinuniffiChangelog
Checklists
All Submissions:
cargo fmtandcargo clippybefore committingchangelog:*labelNew Features:
Bugfixes: