-
Notifications
You must be signed in to change notification settings - Fork 690
docs: Add GitHub Pages deployment to dynamo.github.io for release branches #1542
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
📚 Documentation Preview📖 View Latest Documentation: https://crispy-winner-3jnj38w.pages.github.io/release/0.3.1/pr-1542/
Auto-updated by the documentation deployment workflow |
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
kmkelle-nv
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR adds deployment automation to deploy documentation to dynamo.github.io repository when pushing to release branches.
Walkthrough
A new
deployjob was added to the GitHub Actions workflow for documentation generation. This job depends on thebuild-docsjob, runs only onreleasebranches, and deploys generated documentation to an external repository using a GitHub Pages action, with deployment details dynamically set from the branch and commit.Changes
deployjob that downloads the docs artifact, extracts the branch name, and deploys documentation to an external repo using GitHub Pages.Sequence Diagram(s)
sequenceDiagram participant GitHub Actions participant build-docs Job participant deploy Job participant ai-dynamo/dynamo.github.io Repo GitHub Actions->>build-docs Job: Trigger on push to release branch build-docs Job-->>GitHub Actions: Generate and upload docs artifact GitHub Actions->>deploy Job: Start if build-docs succeeds deploy Job->>deploy Job: Download docs artifact deploy Job->>deploy Job: Extract branch name from GITHUB_REF deploy Job->>ai-dynamo/dynamo.github.io Repo: Deploy docs via gh-pages actionhttps://****.pages.github.io/release/0.3.1/
The current condition if: startsWith(github.ref, 'refs/heads/release') only runs when pushing directly to a release branch, not on PRs targeting release branches.
For PRs, we need to check the target branch (github.base_ref) rather than the source branch (github.ref).