Repository navigation
docs(operator): refresh stale image tags in API doc-comment examples - #13270
Conversation
The Example strings in the DGDR Go doc comments still cited dynamo-planner:1.2.1 / vllm-runtime:1.2.1, and two hand-authored CRD reference pages cited vllm-runtime:0.6.0. These strings propagate into the generated CRD YAML, both Kubernetes API reference pages, and the Python mirror in dgdr_v1beta1_types.py, so all seven surfaces are updated together to 1.4.0 (v1alpha1 and v1beta1 both checked). Signed-off-by: Dan Gil <dagil@nvidia.com>
|
/ok to test 1cec9ef |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1cec9ef546
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (9)
WalkthroughThe pull request updates API comments, CRD examples, and Kubernetes reference documentation to use Dynamo image version ChangesDynamo image version documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This PR refreshes stale image tags in API examples without changing runtime behavior. The source and generated documentation are updated consistently, so no actionable merge-blocking risk remains after normal checks and review. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 golangci-lint (2.12.2)Error: can't load config: unsupported version of the configuration: "" See https://golangci-lint.run/docs/product/migration-guide for migration instructions Comment |
The doc-comment examples cite dynamo-planner:1.4.0; the shipped sample still pinned 1.3.0. v1.4.0 is published, so both now reference the released tag. Signed-off-by: Dan Gil <dagil@nvidia.com>
|
/ok to test 50cd3ec |
This comment has been minimized.
This comment has been minimized.
|
/ok to test 5d5daca |
Same harness fix as on the notes PR: the tag publish put v1.4.0.yml on docs-website with the notes-page pointer main's nav does not carry yet, so the replayed propagation produces pages-dev diffs the pre-rework assertion wrongly counts. Scope the assertion to versions with no pages-dev refs and scrub the sim page from every synced version file. Signed-off-by: Dan Gil <dagil@nvidia.com>
|
/ok to test e3ac943 |
Summary
The DGDR Go doc-comment
Example:strings still citeddynamo-planner:1.2.1/vllm-runtime:1.2.1, and two hand-authored CRD reference pages citedvllm-runtime:0.6.0. These strings propagate into the generated CRD YAML, the Kubernetes API reference pages, and the Python mirror, so all surfaces are updated together to1.4.0:deploy/operator/api/v1beta1/dynamographdeploymentrequest_types.goandv1alpha1(both API versions checked)deploy/operator/config/crd/bases/nvidia.com_dynamographdeploymentrequests.yamldocs/fern/pages/reference/kubernetes-api/{dynamo-graph-deployment-request,full-api-reference,dynamo-component-deployment,dynamo-graph-deployment}.mdxandadditional-resources/api-reference-k8s.mdcomponents/src/dynamo/profiler/utils/dgdr_v1beta1_types.pyFixing at the Go source keeps future doc regens from reintroducing the stale tags (a prior sweep found 22 stale planner tags hiding behind this pattern).
Validation
grep -rn 'planner:1.2.1|vllm-runtime:1.2.1|vllm-runtime:0.6.0'acrossdeploy/operator/, the K8s API docs pages, and the profiler mirror → no matches.pre-commit runon all changed files → clean.🤖 Generated with Claude Code
Summary by CodeRabbit
1.4.0.vllm-runtime:1.4.0.