docs: Add GitHub Pages deployment to dynamo.github.io for release branches

[nvda-mesharma]

This PR adds deployment automation to deploy documentation to dynamo.github.io repository when pushing to release branches.

Walkthrough

A new deploy job was added to the GitHub Actions workflow for documentation generation. This job depends on the build-docs job, runs only on release branches, and deploys generated documentation to an external repository using a GitHub Pages action, with deployment details dynamically set from the branch and commit.

Changes

File(s)	Change Summary
.github/workflows/generate-docs.yml	Added a deploy job 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 action

Loading

Poem

A branch named "release" takes flight,
Docs are built, then launched at night.
With tokens and actions, the pages deploy,
To a repo afar, bringing much joy.
Now every new version, with a hop and a leap,
Finds its home, for all to keep!
🐰✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[nv-anants]

I think ${{ github.ref_name }} should work, for branch name. Can remove the extra step to extract branch name

[nvda-mesharma]

Cursor suggested this approach. I can try to change and see if the simpler ${{ github.ref_name }} works.

[nvda-mesharma]

updated

[nv-anants]

thanks! remove name: Extract branch name step too ? :)

[nvda-mesharma]

done