ci(api-docs): add fork-safe PR preview workflow - #242
Closed
twishabansal wants to merge 1 commit into
Closed
Conversation
twishabansal
marked this pull request as draft
June 2, 2026 08:02
twishabansal
added
the
do not merge
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
2 participants
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.
Summary
Adds a separate, fork-safe API Reference Preview workflow so docs changes can be reviewed before merging — without deploying anything or exposing secrets.
pull_requesttouchingdocs-site/**,scripts/generate-*.sh, the workflow itself, orREADME.md; plusworkflow_dispatchfor previewing any change (e.g. package source) on demand.permissions: contents: readand plainpull_request(notpull_request_target) — runs in the untrusted fork context with no secret access, safe for external contributors.dev+ the root page withBASE_URL="/"(root-relative, self-contained), uploadsdocs-site/publicas theapi-docs-previewartifact (7-day retention), and prints view instructions to the job summary.