Repository navigation
ci: Add Fern docs preview workflows - #538
Open
mikemckiernan wants to merge 2 commits into
Open
mikemckiernan wants to merge 2 commits into
mikemckiernan wants to merge 2 commits into
Conversation
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com> Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
Documentation preview |
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com> Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This branch has not been deployed
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.
Summary
Adds the Fern preview CI from NVIDIA/docs-builder so that PRs with a
fern/directory, such as #536 and #537, get a hosted Fern preview. The files follow the caller examples indocs-builder/_fern_docs_preview_copy.ymland_fern_docs_preview_delete_copy.yml, and the NIM Operator Fern migration (NVIDIA/k8s-nim-operator#980)..github/copy-pr-bot.yaml(enabled: true): copy-pr-bot copies trusted PR commits topull-request/<N>.fern-docs-preview-copy.yml: runs on pushes topull-request/[0-9]+that touchfern/**, and calls_fern_docs_preview_copy.yml@mainwithfern-directory: fern. The Fern CLI version comes fromfern/fern.config.json.fern-docs-preview-delete-copy.yml: runs onpull_request_target: closedfor PRs that touchfern/**, and calls_fern_docs_preview_delete_copy.yml@main, which deletes previewpr-<N>. Thepathsfilter keeps the job from failing on every Sphinx PR close. The job readsfern/fern.config.jsonfrommain, andmainhas nofern/directory yet.The existing Sphinx workflows are unchanged. They trigger on
pull_requestand onpushtomain,release-*andv*tags, so thepull-request/<N>branches from copy-pr-bot don't trigger them. This PR adds no publish workflow.Admin setup this PR can't do:
DOCS_FERN_AWS_ROLE_TO_ASSUMEandDOCS_FERN_SECRET_ID.fern_token_manager.py). The trust must allowpushonrefs/heads/pull-request/*for the preview, andpull_request_targetonmainfor the delete.For review: GitHub has blocked
pull_request_targetby default in public repos since 2026-11-02, so the delete workflow may not run until the repo allows that trigger. If it doesn't run, the only effect is that stale previews stay up._fern_docs_preview_delete_copy.ymlon docs-buildermainstill documentspull_request_target, so this PR uses it too.Link to Devin session: https://nvidia-cloud.devinenterprise.com/sessions/9aa7c0ede21948c58fdb86208d2cde71
Open in Devin Desktop: https://nvidia-cloud.devinenterprise.com/desktop/session/9aa7c0ede21948c58fdb86208d2cde71?variant=devin
Requested by: @mikemckiernan