Repository navigation
ci(docs): add per-PR documentation previews - #11
Merged
Merged
Conversation
Build the MkDocs site on pull requests and publish it to gh-pages/pr-preview/pr-<N>/ via rossjrw/pr-preview-action, posting the preview link as a PR comment and cleaning it up when the PR closes. Coexists with mike (separate gh-pages subtrees). Only deploys for same-repo PRs since fork PRs get a read-only token. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
pr-preview-action (even v1.8.1) still pins Node 20 actions internally. Set FORCE_JAVASCRIPT_ACTIONS_TO_NODE24 to silence the deprecation warning; no-op once Node 24 is the runner default. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Adds
.github/workflows/docs-preview.ymlso every PR that touches docs gets a live preview.On
pull_request(whendocs/**,mkdocs.yml,Pipfile, or this workflow change), it:mkdocs build)gh-pages/pr-preview/pr-<N>/viarossjrw/pr-preview-actionPreview URL format:
https://vngcloud.github.io/vngcloud-load-balancer-controller/pr-preview/pr-<N>/Notes
mike: mike only manages the version folders +versions.json; the action only manages thepr-preview/umbrella, so they don't clash ongh-pages.pull_requestevent, so previews only deploy for same-repo PRs — fork PRs get a read-only token and skip the deploy step.gh-pagesbranch (already done).versions.jsonisn't in the preview subtree) — cosmetic only.🤖 Generated with Claude Code