docs: update 0.5 release notes#362
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
github-actions
Bot
added
size:L
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📜 Recent review details⏰ Context from checks skipped due to timeout. (2)
🧰 Additional context used📓 Path-based instructions (8)**/*.mdx📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Files:
**/*.{rs,py,go,js,ts,jsx,tsx,md,mdx,toml,yaml,yml,html}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/*.{rs,py,go,js,ts,md,mdx,toml,yaml,yml,json}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/*.{md,mdx}📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
{RELEASING.md,docs/**/*.md,docs/**/*.mdx}📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
Files:
**⚙️ CodeRabbit configuration file
Files:
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}⚙️ CodeRabbit configuration file
Files:
🧠 Learnings (1)📓 Common learnings🔇 Additional comments (1)
WalkthroughAdds a release-notes drafting skill and evidence-collection script, then updates the NeMo Relay release-notes pages to 0.5 content and reorganizes the known-issues history. ChangesDraft Release Notes Skill and 0.5 Documentation
Estimated code review effort: 2 (Simple) | ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/about-nemo-relay/release-notes/highlights.mdx`:
- Around line 70-71: The release note sentence in highlights.mdx conflates
primary supported surfaces with experimental ones; update the wording in the
relevant highlights entry so Rust, Python, and Node.js are described as the
supported bindings while Go and the raw C FFI are clearly called out as
experimental and source-first. Use the existing release-notes text in this
section to split the support matrix cleanly, keeping the distinction aligned
with the repo guidance and preserving the same “package, build, test, and
release guidance” context.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: f236f384-dbb8-4cc1-922e-dda0f59246db
📒 Files selected for processing (5)
.agents/skills/draft-release-notes/SKILL.md.agents/skills/draft-release-notes/scripts/collect_release_evidence.pydocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
- GitHub Check: Check / Run
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (12)
.agents/skills/**
⚙️ CodeRabbit configuration file
.agents/skills/**:Maintainer Skills
This directory is the maintainer-only skill set for developing NeMo Relay
itself.Use these skills for repository work such as:
- Changing core or binding APIs
- Maintaining integrations, packaging, CI, and docs
- Extending middleware or observability internals
- Validating library changes across bindings
Consumer-facing NeMo Relay usage skills live in the top-level
skills/
directory so they can be exported separately for integrators and end users.
Files:
.agents/skills/draft-release-notes/scripts/collect_release_evidence.py.agents/skills/draft-release-notes/SKILL.md
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
For documentation-site changes, run the docs build/validation flow (
just docsor./scripts/build-docs.sh html) so generated Fern API reference pages are refreshed before validation.In MDX files, top-of-file comments must use JSX comment delimiters
{/* ... */}for SPDX headers; do not use HTML comments
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
**/*.{rs,py,go,js,ts,jsx,tsx,md,mdx,toml,yaml,yml,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
All source files must include an SPDX license header using the comment syntax appropriate for the file type, with SPDX-FileCopyrightText for 2026 NVIDIA CORPORATION & AFFILIATES and SPDX-License-Identifier: Apache-2.0.
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
**/*.{rs,py,go,js,ts,md,mdx,toml,yaml,yml,json}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Avoid using
SONAR_IGNORE_START/SONAR_IGNORE_ENDexcept for documented false positives; keep the ignored block small, add a brief explanatory comment, and call it out in the PR description.
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
**/*.{md,mdx}: Keep package names, repository references, and build commands current in documentation and examples
Keep stable user-facing wrappers at thescripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
{RELEASING.md,docs/**/*.md,docs/**/*.mdx}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in maintainer-facing docs such as RELEASING.md, not in user-facing docs pages or CHANGELOG.md
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx: Update onlydocs/about-nemo-relay/release-notes/index.mdx,docs/about-nemo-relay/release-notes/highlights.mdx, anddocs/about-nemo-relay/release-notes/known-issues.mdxunless the release changes their route or entry points.
Preserve the MDX front matter and the JSX SPDX comment in the release-notes pages.
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
docs/about-nemo-relay/release-notes/index.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
index.mdxmust provide the current-release summary, compatibility notes, scope, and curated feature links.
Files:
docs/about-nemo-relay/release-notes/index.mdx
**
⚙️ CodeRabbit configuration file
**:AGENTS.md
This file provides guidance to agents, including Claude Code and OpenAI Codex, when working in this repository.
Project Overview
NeMo Relay is a multi-language agent runtime framework for execution scopes, lifecycle events, middleware, plugins, and observability around tool and LLM calls. The core runtime is Rust. Primary supported bindings are Rust, Python, and Node.js. Go and the raw C FFI are experimental and source-first.
The shared runtime model is:
- Scope stacks decide where work belongs and which scope-local behavior is visible.
- Middleware registries decide what guardrails and intercepts run around managed calls.
- Plugins install reusable runtime behavior from configuration.
- Events record runtime behavior in ATOF form.
- Subscribers and exporters consume events in-process or export them to ATIF, OpenTelemetry, OpenInference, or other backends.
Repository Structure
The repository layout separates the Rust runtime, language bindings,
documentation, integrations, and agent-facing skills.crates/ core/ # Rust core runtime crate, published as nemo-relay adaptive/ # Adaptive runtime primitives and plugin components python/ # PyO3 native extension for the Python package ffi/ # Raw C ABI layer used by downstream bindings such as Go node/ # NAPI Node.js binding and JavaScript/TypeScript entry points python/ nemo_relay/ # Python wrapper package: scopes, tools, LLM, middleware, typed helpers, plugins, adaptive helpers tests/ # Python tests go/ nemo_relay/ # Experimental Go CGo binding and tests fern/ # Fern documentation site scripts/ # Stable wrappers and helper scripts; build/test/docs entry points live in justfile skills/ # Published Codex/agent skills for NeMo Relay usage patternsPrerequisites
Insta...
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
docs/about-nemo-relay/release-notes/highlights.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
highlights.mdxmust group notable changes by user-facing theme.
Files:
docs/about-nemo-relay/release-notes/highlights.mdx
docs/about-nemo-relay/release-notes/known-issues.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
known-issues.mdxmust record current limitations, compatibility migrations, current-release fixes, and the complete fixed-item history from earlier release-note pages; preserve every prior fixed-item bullet under release-labelled subsections without summarizing, deduplicating, or omitting anything.
Files:
docs/about-nemo-relay/release-notes/known-issues.mdx
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-06T18:12:26.646Z
Learning: Draft the release-notes pages from verified repository evidence only; verify each candidate claim in changed public docs, API types, command help, or source before including it.
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-06T18:12:26.646Z
Learning: Confirm the target release version from the release branch and package metadata, and preserve unrelated working-tree changes.
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-06T18:12:26.646Z
Learning: Run the read-only helper with explicit previous and current release refs and the target minor version to collect release evidence.
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-06T18:12:26.646Z
Learning: Treat the helper’s grouped output as an evidence index, not publication-ready copy.
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-06T18:12:26.646Z
Learning: Keep the complete PR-by-PR release history in GitHub Releases; do not create a changelog or GitHub Release body from this skill.
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-06T18:12:26.646Z
Learning: Validate the target release by running `git diff --check`, `just docs`, and `just docs-linkcheck`, and review public claims, product names, commands, package names, support claims, and links against the current repository before handoff.
🪛 ast-grep (0.44.1)
.agents/skills/draft-release-notes/scripts/collect_release_evidence.py
[error] 29-35: Command coming from incoming request
Context: subprocess.run(
["git", *args],
cwd=repo,
check=False,
capture_output=True,
encoding="utf-8",
)
Note: [CWE-78] Improper Neutralization of Special Elements used in an OS Command ('OS Command Injection').
(subprocess-from-request)
[warning] 58-58: XPath query is request-/variable-derived; use parameterized XPath to prevent injection.
Context: VERSION_PATTERN.findall(content)
Note: [CWE-643] Improper Neutralization of Data within XPath Expressions ('XPath Injection').
(xpath-injection-python)
🪛 Ruff (0.15.20)
.agents/skills/draft-release-notes/scripts/collect_release_evidence.py
[error] 30-30: subprocess call: check for execution of untrusted input
(S603)
[error] 31-31: Starting a process with a partial executable path
(S607)
[warning] 39-39: Avoid specifying long messages outside the exception class
(TRY003)
🔇 Additional comments (6)
.agents/skills/draft-release-notes/scripts/collect_release_evidence.py (3)
28-45: Static analysis subprocess warnings are false positives here.The S603/S607 and "subprocess-from-request" hints assume untrusted/network-derived input; this is a local maintainer CLI invoked directly with developer-supplied refs, not a service handling requests. No action needed.
54-60: 📐 Maintainability & Code Quality | 💤 Low valueVersion sort is lexicographic, not semantic.
sorted(versions)on strings like"0.9"vs"0.10"will misorder once minor versions reach double digits. Low impact today (report display only), but worth a numeric sort key.♻️ Proposed fix
- return tuple(sorted(versions)) + return tuple(sorted(versions, key=lambda v: tuple(int(part) for part in v.split("."))))
91-96: 🎯 Functional Correctness
python/plugin/pyproject.tomlis a valid path.> Likely an incorrect or invalid review comment..agents/skills/draft-release-notes/SKILL.md (1)
1-65: LGTM!docs/about-nemo-relay/release-notes/index.mdx (1)
13-29: LGTM!Also applies to: 39-52, 55-64
docs/about-nemo-relay/release-notes/known-issues.mdx (1)
12-48: LGTM!Also applies to: 49-60, 61-72, 73-101
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Will Killian <2007799+willkill07@users.noreply.github.com>
Signed-off-by: Will Killian <2007799+willkill07@users.noreply.github.com>
|
/merge |
3 participants
Overview
Update the documentation-site release notes for NVIDIA NeMo Relay 0.5 and add a maintainer skill that gathers release evidence from Git history.
Details
draft-release-notes, including a read-only Git evidence collector that compares release-note trees and groups commits for maintainer review.Where should the reviewer start?
Start with
docs/about-nemo-relay/release-notes/known-issues.mdxfor the complete prior-release fix history, then review.agents/skills/draft-release-notes/SKILL.mdand its evidence collector.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit