Skip to content

Conversation

@nvda-mesharma
Copy link
Contributor

@nvda-mesharma nvda-mesharma commented Jun 16, 2025

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
  1. Trying to resolve 404 issue
    https://****.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).

  1. Adding a PR comment with the docs link

Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
@nvda-mesharma nvda-mesharma self-assigned this Jun 16, 2025
@nvda-mesharma nvda-mesharma requested review from a team and nnshah1 as code owners June 16, 2025 19:34
@nvda-mesharma nvda-mesharma marked this pull request as draft June 16, 2025 19:34
@github-actions github-actions bot added the docs label Jun 16, 2025
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>
@nvda-mesharma nvda-mesharma marked this pull request as ready for review June 16, 2025 19:55
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>
@github-actions
Copy link

github-actions bot commented Jun 16, 2025

📚 Documentation Preview

📖 View Latest Documentation: https://crispy-winner-3jnj38w.pages.github.io/release/0.3.1/pr-1542/

Latest Deployment:

  • Commit: c41de578 (latest push)
  • Target: release/0.3.1
  • Updated: 6/30/25, 5:20 PM UTC

Note: This link always shows the documentation for the latest commit. It may take a few minutes for GitHub Pages to update after each push.


Auto-updated by the documentation deployment workflow

Signed-off-by: Meenakshi Sharma <163925564+nvda-mesharma@users.noreply.github.com>
@ai-dynamo ai-dynamo deleted a comment from github-actions bot Jun 17, 2025
@ai-dynamo ai-dynamo deleted a comment from github-actions bot Jun 17, 2025
@ai-dynamo ai-dynamo deleted a comment from github-actions bot Jun 17, 2025
@ai-dynamo ai-dynamo deleted a comment from github-actions bot Jun 17, 2025
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>
Copy link
Contributor

@kmkelle-nv kmkelle-nv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nvda-mesharma nvda-mesharma merged commit e117295 into release/0.3.1 Jun 30, 2025
13 of 15 checks passed
@nvda-mesharma nvda-mesharma deleted the release/docs branch June 30, 2025 18:45
@nvda-mesharma nvda-mesharma restored the release/docs branch June 30, 2025 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants