Skip to content

ci: build and deploy docs to gh-pages on release#1374

Merged
developerkunal merged 1 commit into
masterfrom
ci/docs-gh-pages-deploy
Jul 21, 2026
Merged

ci: build and deploy docs to gh-pages on release#1374
developerkunal merged 1 commit into
masterfrom
ci/docs-gh-pages-deploy

Conversation

@developerkunal

Copy link
Copy Markdown
Contributor

Changes

Moves API reference documentation generation out of the committed source tree and into CI, publishing to the gh-pages branch on release.

  • Adds a deploy-docs composite action (.github/actions/deploy-docs) that installs dependencies, runs yarn docs:build (TypeDoc), and pushes the generated ./docs output to the gh-pages branch using peaceiris/actions-gh-pages.
  • Adds a deploy-docs job to the release workflow (.github/workflows/release.yml). It runs after the release job and is gated on the same condition, so docs are only rebuilt and deployed on an actual release (a merged release/* PR or a manual workflow_dispatch).
  • Stops tracking the generated docs/ folder in git and adds /docs to .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 the gh-pages branch to confirm the site renders correctly. On release, the workflow reproduces the same build and deploy steps.

  • This change adds unit test coverage
  • This change adds integration test coverage

Checklist

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.
@developerkunal
developerkunal requested a review from a team as a code owner July 20, 2026 16:42
@codecov

codecov Bot commented Jul 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.76%. Comparing base (a823058) to head (eaa453f).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1374   +/-   ##
=======================================
  Coverage   89.76%   89.76%           
=======================================
  Files         431      431           
  Lines       20108    20108           
  Branches     9782     9782           
=======================================
  Hits        18049    18049           
  Misses       2059     2059           
Flag Coverage Δ
alltests 89.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@developerkunal
developerkunal enabled auto-merge (squash) July 20, 2026 17:14
@developerkunal
developerkunal merged commit ab625f6 into master Jul 21, 2026
11 checks passed
@developerkunal
developerkunal deleted the ci/docs-gh-pages-deploy branch July 21, 2026 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants