ci: build and deploy docs to gh-pages on release#1374
Merged
Conversation
Move TypeDoc generation out of the committed tree and into CI. A new deploy-docs composite action builds the docs and pushes them to the gh-pages branch, wired into the release workflow so it only runs on release. The generated docs/ folder is now gitignored and untracked.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1374 +/- ##
=======================================
Coverage 89.76% 89.76%
=======================================
Files 431 431
Lines 20108 20108
Branches 9782 9782
=======================================
Hits 18049 18049
Misses 2059 2059
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
ankita10119
approved these changes
Jul 20, 2026
developerkunal
enabled auto-merge (squash)
July 20, 2026 17:14
amitsingh05667
approved these changes
Jul 21, 2026
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.
Changes
Moves API reference documentation generation out of the committed source tree and into CI, publishing to the
gh-pagesbranch on release.deploy-docscomposite action (.github/actions/deploy-docs) that installs dependencies, runsyarn docs:build(TypeDoc), and pushes the generated./docsoutput to thegh-pagesbranch usingpeaceiris/actions-gh-pages.deploy-docsjob to the release workflow (.github/workflows/release.yml). It runs after thereleasejob and is gated on the same condition, so docs are only rebuilt and deployed on an actual release (a mergedrelease/*PR or a manualworkflow_dispatch).docs/folder in git and adds/docsto.gitignore. The 5255 previously committed TypeDoc HTML files are removed from the repository, since they are now produced by CI.No SDK surface changes. This is a documentation and CI-only change.
References
N/A
Testing
The docs build was verified locally with
yarn docs:build(TypeDoc completes with 0 errors). The generated output was manually published to thegh-pagesbranch to confirm the site renders correctly. On release, the workflow reproduces the same build and deploy steps.Checklist