Skip to content

ci(docs): finish setting up PR doc preview workflow#160

Merged
drew merged 17 commits intomainfrom
miyoungc/doc-build-wf
Mar 10, 2026
Merged

ci(docs): finish setting up PR doc preview workflow#160
drew merged 17 commits intomainfrom
miyoungc/doc-build-wf

Conversation

@miyoungc
Copy link
Collaborator

@miyoungc miyoungc commented Mar 6, 2026

Worked with Claude. The workflow is:

  1. Downloads the HTML artifact + PR info from the Docs workflow run
  2. Checks out gh-pages and copies the preview into review/pr-/
  3. Pushes to gh-pages (not main)
  4. Posts/updates a comment on the PR with the preview URL.
    The preview will be available at something like:
    https://nvidia.github.io/NemoClaw/review/pr-160/

@miyoungc miyoungc changed the title docs: revert the doc build holder ci(docs): revert the doc build holder Mar 6, 2026
@mikemckiernan
Copy link
Member

sugg: Add in the docs-preview-pr file and replace the reference for main with bdb56efb3188fe2bb9be1356bf717e88e7269924.

@miyoungc miyoungc requested a review from drew March 7, 2026 00:49
@miyoungc miyoungc marked this pull request as draft March 7, 2026 01:07
@miyoungc miyoungc changed the title ci(docs): revert the doc build holder ci(docs): finish setting up PR doc preview workflow Mar 7, 2026
miyoungc added 6 commits March 9, 2026 14:42
…s deploy

The nvidia-merlin shared workflow was pushing to main instead of gh-pages,
violating branch protection rules. Inline the preview logic to push built
docs to gh-pages under review/pr-<number>/ and comment the preview URL.
@miyoungc miyoungc force-pushed the miyoungc/doc-build-wf branch from 42d9126 to 97acc6f Compare March 9, 2026 21:43
@miyoungc miyoungc marked this pull request as ready for review March 9, 2026 21:53
@miyoungc miyoungc self-assigned this Mar 9, 2026
@miyoungc miyoungc added the area:docs Documentation and examples label Mar 9, 2026
@miyoungc miyoungc linked an issue Mar 9, 2026 that may be closed by this pull request
7 tasks
@miyoungc miyoungc added this to the gtc milestone Mar 10, 2026
drew added 5 commits March 9, 2026 21:50
- Replace custom workflow_run-based preview with rossjrw/pr-preview-action
- Simplify docs-build.yml to only handle main branch deployments
- Preview workflow now builds docs directly and deploys to gh-pages
- Automatic cleanup when PRs are closed
- Sticky comments with preview URLs handled by the action
@github-actions
Copy link

github-actions bot commented Mar 10, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-10 05:59 UTC

@drew drew merged commit 59aa42b into main Mar 10, 2026
13 checks passed
@drew drew deleted the miyoungc/doc-build-wf branch March 10, 2026 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation and examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants