feat!: remove project configuration layering - #720
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
WalkthroughThe change removes project-local configuration discovery and editing. Configuration now uses explicit, user, and system layers. Legacy project files appear as inactive doctor warnings. CLI tests and documentation now use user-scoped XDG paths. ChangesConfiguration layer simplification
Estimated code review effort: 4 (Complex) | ~45 minutes Sequence Diagram(s)sequenceDiagram
participant CLI
participant ConfigurationResolver
participant CorePluginResolver
participant SystemConfig
CLI->>ConfigurationResolver: select explicit-or-user configuration
ConfigurationResolver->>CorePluginResolver: resolve plugin paths
CorePluginResolver->>SystemConfig: include system configuration
SystemConfig-->>CorePluginResolver: return system path
CorePluginResolver-->>ConfigurationResolver: return effective paths
ConfigurationResolver-->>CLI: load configuration
Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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)level=error msg="[linters_context] typechecking error: pattern ./...: directory prefix . does not contain main module or its selected dependencies" Comment |
github-actions
Bot
added
size:XL
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
go/nemo_relay/plugin_activation_test.go (1)
624-658: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick winAdd Go Coverage for Ignored Project Plugin Files.
This helper creates only the user
plugins.toml. The test cannot detect a project-layer merge or fallback.Create a legacy
.nemo-relay/plugins.tomlunderprojectDir. Use a malformed file beside the valid user file. Add a project-only case that confirms activation does not load the legacy component.Proposed fixture addition
func configureNativePluginUserConfig(t *testing.T) string { t.Helper() projectDir := t.TempDir() + legacyPluginsTOML := filepath.Join(projectDir, ".nemo-relay", "plugins.toml") + if err := os.MkdirAll(filepath.Dir(legacyPluginsTOML), 0o700); err != nil { + t.Fatalf("MkdirAll(legacy project config) error = %v", err) + } + if err := os.WriteFile(legacyPluginsTOML, []byte("components = ["), 0o600); err != nil { + t.Fatalf("WriteFile(legacy plugins.toml) error = %v", err) + } xdgConfigHome := filepath.Join(projectDir, "xdg")Run
cd go/nemo_relay && go fmt ./...andjust test-goafter adding the cases. As per path instructions, “Any API change should include focused Go tests and consider race-test behavior.”🤖 Prompt for 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. In `@go/nemo_relay/plugin_activation_test.go` around lines 624 - 658, Add a malformed legacy project-layer .nemo-relay/plugins.toml under projectDir in configureNativePluginUserConfig, then add a project-only activation test that verifies the legacy component is ignored and is not loaded. Preserve the existing valid user-file setup, and run gofmt plus the Go test suite afterward.Sources: Coding guidelines, Path instructions
🤖 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/configure-plugins/model-pricing.mdx`:
- Around line 71-73: Update the model-pricing command examples to use
<path/to/pricing.json> instead of /path/to/pricing.json in both validate and
add-source commands, and state that readers must replace the placeholder with
their actual pricing file path before running them.
In `@docs/configure-plugins/plugin-configuration-files.mdx`:
- Around line 390-398: Remove stale project-configuration guidance across the
documented sites: in docs/configure-plugins/plugin-configuration-files.mdx
(lines 390-398), update the nearby example to use the supported explicit-or-user
layer instead of “project or user file”; in docs/nemo-relay-cli/basic-usage.mdx
(lines 351-355), remove “project” from model-pricing resolution guidance; and in
docs/nemo-relay-cli/codex.mdx (lines 289-290), remove or rewrite the statement
so transparent runs do not imply they load ignored project configuration.
In `@integrations/coding-agents/codex/README.md`:
- Around line 166-175: Update the configuration-layer documentation in the
README, especially the section around the referenced lines, to remove any claim
that transparent runs use repository-local .nemo-relay files. State that
nemo-relay run uses system and user configuration layers, or an explicit
--config path with its sibling plugins.toml, while preserving the existing
user-default configuration guidance.
In `@README.md`:
- Around line 114-115: Update the README guidance for repository-local
`.nemo-relay/plugins.toml` files to use a supported, discoverable public
configuration option or stable wrapper command instead of the hidden
`--plugin-config-path` override. Do not document that internal option as the
user-facing escape hatch.
---
Outside diff comments:
In `@go/nemo_relay/plugin_activation_test.go`:
- Around line 624-658: Add a malformed legacy project-layer
.nemo-relay/plugins.toml under projectDir in configureNativePluginUserConfig,
then add a project-only activation test that verifies the legacy component is
ignored and is not loaded. Preserve the existing valid user-file setup, and run
gofmt plus the Go test suite afterward.
🪄 Autofix
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: fa04ef36-af44-4cb2-a698-dcb97762e73d
📒 Files selected for processing (59)
README.mdcrates/cli/README.mdcrates/cli/src/agents/hermes/integration.rscrates/cli/src/bootstrap/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/configure/model.rscrates/cli/src/commands/configure/wizard.rscrates/cli/src/commands/configure/wizard/prompt.rscrates/cli/src/commands/logging.rscrates/cli/src/commands/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/root.rscrates/cli/src/commands/serve.rscrates/cli/src/configuration/mod.rscrates/cli/src/diagnostics/mod.rscrates/cli/src/diagnostics/model.rscrates/cli/src/diagnostics/render.rscrates/cli/src/mcp_environment.rscrates/cli/src/plugins/config_io.rscrates/cli/src/plugins/lifecycle/mod.rscrates/cli/src/plugins/lifecycle/state.rscrates/cli/src/plugins/mod.rscrates/cli/src/plugins/pricing.rscrates/cli/src/plugins/types.rscrates/cli/src/process/launcher.rscrates/cli/tests/cli_tests.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/commands/main_tests.rscrates/cli/tests/coverage/commands/model_pricing_tests.rscrates/cli/tests/coverage/shared/bootstrap_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/plugins_lifecycle_tests.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/tests/coverage/shared/setup_tests.rscrates/core/src/plugin.rscrates/core/tests/integration/native_plugin_tests.rscrates/core/tests/unit/plugin_tests.rscrates/ffi/tests/integration/plugin_activation_tests.rscrates/node/tests/dynamic_plugin_tests.mjsdocs/about-nemo-relay/release-notes/index.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/configure-plugins/model-pricing.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdxdocs/reference/migration-guides.mdxdocs/reference/operational-logging.mdxgo/nemo_relay/plugin_activation_test.gointegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mdpython/tests/test_dynamic_plugin_host.py
💤 Files with no reviewable changes (4)
- crates/cli/src/plugins/types.rs
- crates/cli/tests/coverage/shared/bootstrap_tests.rs
- crates/cli/tests/coverage/commands/configure_editor_tests.rs
- crates/cli/src/mcp_environment.rs
Signed-off-by: Will Killian <wkillian@nvidia.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
crates/cli/README.md (1)
147-151: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDistinguish automatic discovery from explicit selection.
Line 151 and Line 205 say that repository-local files are ignored. The same section documents
--configand--plugin-config-pathas explicit selectors, so users can still select repository-local files deliberately. State that these files are “not discovered automatically” instead.As per path instructions, this README must match current command behavior. Based on the PR objective, legacy files remain selectable through explicit configuration.
Suggested wording
-Repository-local `.nemo-relay/config.toml` files are ignored. +Repository-local `.nemo-relay/config.toml` files are not discovered automatically; select one explicitly with `--config`. ... -Repository-local `.nemo-relay/plugins.toml` files are ignored. +Repository-local `.nemo-relay/plugins.toml` files are not discovered automatically; select one explicitly with `--plugin-config-path`.Also applies to: 195-205
🤖 Prompt for 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. In `@crates/cli/README.md` around lines 147 - 151, Update the repository-local configuration wording in the runtime/configuration documentation, including the sections around the user config precedence and plugin configuration, to state that `.nemo-relay/config.toml` files are not discovered automatically rather than ignored. Preserve that explicitly selected legacy files remain supported through `--config` and `--plugin-config-path`.Source: Path instructions
🤖 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.
Outside diff comments:
In `@crates/cli/README.md`:
- Around line 147-151: Update the repository-local configuration wording in the
runtime/configuration documentation, including the sections around the user
config precedence and plugin configuration, to state that
`.nemo-relay/config.toml` files are not discovered automatically rather than
ignored. Preserve that explicitly selected legacy files remain supported through
`--config` and `--plugin-config-path`.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 6e058f19-4dfa-4db0-b7eb-e17396b6e1d0
📒 Files selected for processing (20)
crates/cli/README.mdcrates/cli/src/commands/configure/editor.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/configuration/mod.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/tests/coverage/shared/setup_tests.rscrates/core/src/plugin.rscrates/core/tests/unit/plugin_tests.rsdocs/configure-plugins/model-pricing.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/reference/migration-guides.mdxintegrations/coding-agents/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
- GitHub Check: Check / Run
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (32)
**/*.rs
📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)
**/*.rs: Any Rust change must runjust test-rust
Any Rust change must runcargo fmt --all
Any Rust change must runcargo clippy --workspace --all-targets -- -D warnings
**/*.rs: Runcargo fmt --allfor all FFI work since it is Rust work
Runjust test-rustto validate FFI changes
Runcargo clippy --workspace --all-targets -- -D warningsto enforce strict linting on FFI workWhen Rust files changed as part of Go work, also run
cargo fmt --all,just test-rust, andcargo clippy --workspace --all-targets -- -D warnings
**/*.rs: Runcargo fmt --allwhen Rust files are changed as part of Node work
Runcargo clippy --workspace --all-targets -- -D warningswhen Rust files are changed as part of Node work
Runjust test-rustwhen Rust files are changed as part of Node work
**/*.rs: If any Rust code changed, always runjust test-rust.
If any Rust code changed, also runcargo fmt --all.
If any Rust code changed, also runcargo clippy --workspace --all-targets -- -D warnings.
For Rust changes headed for review, runcargo fmt --allandcargo clippy --workspace --all-targets -- -D warningseven if relying on pre-commit.
**/*.rs: Format Rust code with rustfmt defaults usingcargo fmt.
Runcargo clippy -- -D warnings; all Rust warnings must be treated as errors.
Use Rustsnake_casenaming conventions.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
{crates/core,crates/adaptive}/**/*
📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)
Changes to
crates/coreorcrates/adaptivemust run the full language matrix
Files:
crates/core/tests/unit/plugin_tests.rscrates/core/src/plugin.rs
crates/core/**/*.rs
📄 CodeRabbit inference engine (.agents/skills/test-go-binding/SKILL.md)
If the change touched
crates/coreor shared runtime semantics, also usevalidate-changefor broader validationUse
Result<T>withFlowErrorin core runtime paths, keeping wrapper-layer errors explicit and binding-appropriate.
Files:
crates/core/tests/unit/plugin_tests.rscrates/core/src/plugin.rs
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
**/*: Use release tags in raw Rust-compatible SemVer without a leadingv; tags such asv0.1.0are prohibited.
Use branch prefixesfeat/,fix/,docs/,test/, orrefactor/according to the change purpose.
Every commit in a pull request must include a DCOSigned-off-by:sign-off.
Before submitting a pull request, ensure pre-commit hooks, relevant tests, target-specific builds, documentation updates, and a rebase on the latestmainare complete.
Use commit messages in the formtype: short description, with a valid type and a first line under 72 characters.
Files:
crates/core/tests/unit/plugin_tests.rsdocs/nemo-relay-cli/basic-usage.mdxcrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rsdocs/configure-plugins/model-pricing.mdxcrates/cli/src/commands/configure/editor.rsdocs/reference/migration-guides.mdxcrates/cli/README.mddocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/README.mdcrates/cli/tests/coverage/shared/plugins_tests.rsdocs/integrate-into-frameworks/provider-response-codecs.mdxcrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
crates/{core,adaptive}/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If
crates/coreorcrates/adaptivechanged, run the full validation matrix across Rust, Python, Go, and Node.js.
Files:
crates/core/tests/unit/plugin_tests.rscrates/core/src/plugin.rs
**/*.{rs,py,go,js,ts}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If a language surface changed, always run that language's test target even when Rust core did not change.
**/*.{rs,py,go,js,ts}: When observability configuration or lifecycle is exposed, keep FFI and Python, Go, and Node.js binding-native config objects and subscriber/exporter methods aligned in logical knobs and semantics.
Require every OpenTelemetry endpoint to have a type and nonblank destination; resolveheader_envvalues at activation and reject missing, blank, or duplicate headers.
Concatenate layered ATOF sink, ATIF storage, and OpenTelemetry endpoint lists with higher-precedence entries first.
Preserve correct handling of mark events, start/end events, orphan cases, and span or trajectory fields derived from intended event data.
Run affected Rust tests andjust test-rustwhen event fields change; runjust test-python,just test-go, andjust test-nodewhen binding-native configuration or lifecycle changes.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/*.{rs,py,js,ts,tsx,go,java,kt,swift}
📄 CodeRabbit inference engine (.agents/skills/add-middleware/SKILL.md)
Add tests covering registration and duplicate names, deregistration and missing names, priority ordering, callback failure policy, scope-local inheritance and cleanup, event payload semantics, immutable mark and scope fields, and parity across affected bindings.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/*.{rs,py,js,jsx,ts,tsx,go,c,h,cc,cpp,md,toml,yml,yaml,sh}
📄 CodeRabbit inference engine (AGENTS.md)
Keep SPDX headers on source, documentation, scripts, and configuration files; the project is Apache-2.0.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/README.mdintegrations/coding-agents/README.mdcrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/*.{rs,py}
📄 CodeRabbit inference engine (AGENTS.md)
Use
snake_casenaming in Rust and Python.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
crates/**/*.rs
📄 CodeRabbit inference engine (AGENTS.md)
crates/**/*.rs: UseJson = serde_json::Valuein Rust-facing runtime APIs where existing code expects JSON payloads.
Treat Rust as the source of truth for runtime behavior; binding APIs should mirror Rust semantics unless a language-specific wrapper intentionally improves ergonomics.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/*.{rs,py,js,mjs,ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
Preserve the existing Tokio-based asynchronous model and callback/future lifetimes; do not unexpectedly block or hide async work in bindings.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/*.{rs,py,go,js,jsx,ts,tsx,c,h}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.{rs,py,go,js,jsx,ts,tsx,c,h}: Run tests for every language affected by a change; changes to the core Rust crate require tests across all bindings.
UseSONAR_IGNORE_START/SONAR_IGNORE_ENDonly for documented false positives, keep ignored blocks minimal, explain them with a comment, and obtain reviewer sign-off.
Preserve the layered architecture in which Rust provides the core runtime and C FFI, PyO3, and NAPI provide bindings that mirror the full API surface.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/{test,tests}/**/*
📄 CodeRabbit inference engine (CONTRIBUTING.md)
When adding functionality, include tests in the appropriate test files for each affected language binding.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/*.{rs,py,go,js,jsx,ts,tsx,c,h,html,md,mdx,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include the appropriate SPDX copyright and Apache-2.0 license header in every source file.
Files:
crates/core/tests/unit/plugin_tests.rsdocs/nemo-relay-cli/basic-usage.mdxcrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rsdocs/configure-plugins/model-pricing.mdxcrates/cli/src/commands/configure/editor.rsdocs/reference/migration-guides.mdxcrates/cli/README.mddocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/README.mdcrates/cli/tests/coverage/shared/plugins_tests.rsdocs/integrate-into-frameworks/provider-response-codecs.mdxcrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
crates/{core,adaptive}/**/*.rs
⚙️ CodeRabbit configuration file
crates/{core,adaptive}/**/*.rs: Review the Rust runtime for async correctness, scope isolation, middleware ordering, and event lifecycle regressions.
Pay close attention to task-local/thread-local scope propagation, callback lifetimes, stream finalization, and root_uuid isolation.
Public API changes should preserve existing behavior unless tests and docs show the intended migration path.
Files:
crates/core/tests/unit/plugin_tests.rscrates/core/src/plugin.rs
{crates/**/tests/**,python/tests/**,go/nemo_relay/**/*_test.go}
⚙️ CodeRabbit configuration file
{crates/**/tests/**,python/tests/**,go/nemo_relay/**/*_test.go}: Tests should cover the behavior promised by the changed API surface, including error paths and cross-request isolation where relevant.
Prefer assertions on lifecycle events, scope stacks, middleware ordering, and binding parity over shallow smoke tests.
Files:
crates/core/tests/unit/plugin_tests.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
**/*.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)
**/*.mdx: In MDX files, top-of-file comments must use JSX comment delimiters ({/*and*/}); do not use HTML comments for MDX SPDX headers.
New or regenerated MDX files must use{/* ... */}for top-of-file SPDX comments.
Files:
docs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If links in documentation change, run
just docs-linkcheck.Use documented public APIs and stable wrapper commands in examples and user-facing documentation; do not rely on internal helpers.
**/*.{md,mdx}: Prefer the documented public API over internal shortcuts in documentation and examples.
Keep package names, repository references, and build commands current.
Contribution workflow documentation must require an issue before external contribution pull requests and note that NVIDIA contributors may use a GitHub or Linear issue.
Update entry-point documentation when examples or reading paths change.
Keep release-process and release-notes guidance in maintainer documentation such asRELEASING.md, rather than user-facing documentation pages orCHANGELOG.md.
Use stable user-facing wrappers at thescripts/root in documentation and examples; reference namespaced helper paths only for internal maintenance documentation.
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pages.
Dynamic plugin manifests in documentation and examples should usecompat.relay = ">=0.5,<1.0"unless deliberately narrower.
Render images, diagrams, tables, and other visual content at representative page widths, ensuring legibility and complete access without clipping; use responsive scaling, reflow, or overflow as appropriate and scope visual styling narrowly.
Dynamic plugin entry pages should link to native, worker, Rust example, Python example, and protocol pages when those pages exist.
Images, diagrams, tables, and custom visual content must remain legible and fully accessible at representative desktop and narrow page widths.
Release-policy documentation must point to GitHub Releases as the only release-history source of truth.
Runjust docswhen the documentation site changes; retain./scripts/build-docs.sh htmlas the compatibility wrapper.
Files:
docs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxcrates/cli/README.mddocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/README.mddocs/integrate-into-frameworks/provider-response-codecs.mdx
**/*.{md,mdx,py,go,js,ts}
📄 CodeRabbit inference engine (.agents/skills/maintain-observability/SKILL.md)
Examples and documentation must use each exporter's documented flush/deregister order before shutdown.
Files:
docs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxcrates/cli/README.mddocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/README.mddocs/integrate-into-frameworks/provider-response-codecs.mdx
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant reference documentation when public behavior or APIs change.
Files:
docs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdx
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,mdx,rst}: Use title case consistently for technical documentation headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title case.
Format code elements, commands, parameters, package names, expressions, directories, file names, and paths in monospace; represent path placeholders with angle brackets inside monospace.
Format UI buttons, menus, fields, and labels in bold, and separate consecutive UI navigation labels with>.
Use quotation marks for error messages and strings when appropriate, italics for newly introduced terms and publication titles, and plain text for keyboard shortcuts.
Represent GitHub repositories with owner/repository link text, such as[NVIDIA/NeMo](link), rather than generic repository wording.
Introduce every code block with a complete sentence; do not let a code block complete or interrupt the grammar of surrounding prose; use syntax highlighting when supported.
Keep inline method, function, and class references consistent with nearby documentation; omit empty parentheses in prose when no call is shown.
Use descriptive link text matching the destination title when possible; avoid raw URLs, generic anchors, long-sentence links, and unnecessary links that distract from procedures.
Ensure lists have a complete lead-in sentence, more than one item, no more than two levels, parallel construction, one idea or action per item, and appropriate punctuation; use bullets for unordered items and numbers for ordered tasks.
Format definition lists with a bold term followed by a complete, parallel, punctuated definition.
Use tables for reference information, decision support, compatibility matrices, and comparable choices; flag one-row tables, missing captions or lead-ins, sentence-case headers where title case is expected, unexplained empty cells, and code or links that would be clearer as prose.
Write procedure steps as imperative ...
Files:
docs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxcrates/cli/README.mddocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/README.mddocs/integrate-into-frameworks/provider-response-codecs.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/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/model-pricing.mdxdocs/reference/migration-guides.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdx
{crates/**/src/**/*.rs,python/**/*.py}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Do not add tests under
src; Rust tests belong in cratetests/trees, and Python SDK tests belong underpython/tests.
Files:
crates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/src/diagnostics/mod.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rs
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
crates/cli/README.mdintegrations/coding-agents/README.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
crates/cli/README.mdintegrations/coding-agents/README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
crates/cli/README.mdintegrations/coding-agents/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as "here" or "read more."
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
crates/cli/README.mdintegrations/coding-agents/README.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update the relevant crate or package README when that package surface changes.
Update relevant package or crate
README.mdfiles when examples or binding guidance changes.
Files:
crates/cli/README.mdintegrations/coding-agents/README.md
**/{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update
README.mdordocs/index.mdwhen documentation entry points change.
Files:
crates/cli/README.mdintegrations/coding-agents/README.md
docs/integrate-into-frameworks/**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Update docs if activation or usage changes.
Files:
docs/integrate-into-frameworks/provider-response-codecs.mdx
🧠 Learnings (2)
📚 Learning: 2026-08-03T19:55:03.931Z
Learnt from: afourniernv
Repo: NVIDIA/NeMo-Relay PR: 558
File: crates/pii-redaction/src/rampart/mod.rs:265-274
Timestamp: 2026-08-03T19:55:03.931Z
Learning: In NeMo Relay first-party plugin registration helpers, treat the documented duplicate-registration `PluginError::RegistrationFailed` result from `register_plugin` as success when registration is intended to be idempotent. Do not locally reclassify this as `PluginError::Conflict`; changing the classification requires a core-wide review of the public API and FFI behavior.
Applied to files:
crates/core/tests/unit/plugin_tests.rscrates/cli/src/commands/plugins/subcommands.rscrates/cli/src/commands/configure/mod.rscrates/cli/src/commands/model_pricing/mod.rscrates/cli/src/commands/configure/editor.rscrates/cli/tests/coverage/shared/plugins_tests.rscrates/cli/src/diagnostics/mod.rscrates/cli/tests/coverage/commands/configure_editor_tests.rscrates/cli/tests/coverage/shared/config_tests.rscrates/cli/src/configuration/mod.rscrates/core/src/plugin.rscrates/cli/tests/coverage/shared/doctor_tests.rscrates/cli/tests/coverage/shared/setup_tests.rs
📚 Learning: 2026-07-28T20:07:29.880Z
Learnt from: willkill07
Repo: NVIDIA/NeMo-Relay PR: 571
File: crates/core/src/api/runtime/state.rs:996-1020
Timestamp: 2026-07-28T20:07:29.880Z
Learning: In NeMo Relay (RELAY-509), sanitizer callback failures must be treated as intentional fail-open behavior. When an event/tool (request/response) or LLM (request/response) sanitizer callback fails, the sanitizer chain should retain and publish the last valid event/payload snapshot (rather than dropping/invalidating the data) and log the failure including callback context (e.g., which sanitizer/callback failed and relevant identifiers). Apply this consistently across all sanitizer chains mentioned in the RELAY-509 documentation/migration guide.
Applied to files:
crates/core/src/plugin.rs
🪛 LanguageTool
docs/configure-plugins/plugin-configuration-files.mdx
[style] ~291-~291: The double modal “requires elevated” is nonstandard (only accepted in certain dialects). Consider “to be elevated”.
Context: ...s.toml` on Windows and usually requires elevated filesystem permissions. The editor men...
(NEEDS_FIXED)
🔇 Additional comments (26)
crates/cli/src/commands/configure/editor.rs (1)
550-550: LGTM!crates/cli/src/commands/configure/mod.rs (1)
47-47: LGTM!crates/cli/src/commands/model_pricing/mod.rs (1)
42-44: LGTM!Also applies to: 95-100
crates/cli/src/commands/plugins/subcommands.rs (1)
78-80: LGTM!Also applies to: 153-156
crates/cli/src/configuration/mod.rs (2)
1132-1132: LGTM!Also applies to: 1147-1151
1076-1084: 🗄️ Data Integrity & IntegrationInspect the shared loader’s precedence semantics.
config_pathsreturns the explicit or user path before the system path. This is safe only if later paths override earlier paths. If earlier paths take precedence, user or explicit configuration can override system policy. Add conflicting-value tests for both combinations.crates/cli/src/diagnostics/mod.rs (2)
172-190: LGTM!
166-171: 🎯 Functional CorrectnessConfirm the
homeargument contract. Ifhomeis an override, resolveglobal_pathfrom that context instead of the process environment. Add a test withXDG_CONFIG_HOMEset.crates/core/src/plugin.rs (1)
2050-2073: 📐 Maintainability & Code QualityRun the required validation before handoff.
The validation suite is still pending. Run formatting, linting, Rust tests,
validate-change, all binding tests, and the full pre-commit pass.crates/cli/tests/coverage/shared/config_tests.rs (1)
51-80: LGTM!Also applies to: 91-111, 120-120, 137-160, 169-170, 201-202, 299-299, 308-330, 669-710, 1101-1127, 1136-1155, 1185-1197, 1228-1237, 2700-2700, 2898-2901
crates/cli/tests/coverage/shared/doctor_tests.rs (1)
50-50: LGTM!Also applies to: 60-68, 149-161, 216-216, 376-376, 408-408, 650-659, 941-941
crates/cli/tests/coverage/shared/plugins_tests.rs (2)
5-5: LGTM!Also applies to: 159-160, 3091-3091
1921-1948: 🔒 Security & Privacy
crates/cli/tests/coverage/shared/setup_tests.rs (1)
115-115: LGTM!Also applies to: 128-128, 141-142, 156-174, 184-188, 204-207, 235-258, 267-268, 290-290, 306-315, 333-334, 354-355, 371-378, 393-468, 483-513, 530-530
crates/core/tests/unit/plugin_tests.rs (2)
2645-2656: LGTM!Also applies to: 2658-2669
2645-2669: 📐 Maintainability & Code QualityRun the required validation before handoff.
The supplied context does not include validation results. Run the checks required for each changed path.
crates/core/tests/unit/plugin_tests.rs#L2645-L2669: Runvalidate-change,cargo fmt --all,cargo clippy --workspace --all-targets -- -D warnings,just test-rust,just test-python,just test-go,just test-node, anduv run pre-commit run --all-files.crates/cli/tests/coverage/commands/configure_editor_tests.rs#L202-L241: Runcargo fmt --all,cargo clippy --workspace --all-targets -- -D warnings,just test-rust, anduv run pre-commit run --all-files.docs/configure-plugins/model-pricing.mdx#L76-L80: Runjust docsanduv run pre-commit run --all-files.As per coding guidelines, run the required language-specific and documentation validation before handoff.
Source: Coding guidelines
crates/cli/tests/coverage/commands/configure_editor_tests.rs (2)
202-205: LGTM!Also applies to: 208-217
234-241: 🗄️ Data Integrity & IntegrationConfirm global atomic-write failure coverage.
If no test covers a failed
TargetScope::Globalwrite, addfail_next_atomic_writeand assert thatglobal_pathremains unchanged.docs/nemo-relay-cli/basic-usage.mdx (3)
355-360: Remove the remainingprojectpricing-layer reference.The updated examples use
--userand--global, but Line 375 still listsprojectpricing files. Replace that term with the supported explicit, user, and system layers.This is the same stale project-configuration guidance identified in the previous review.
147-159: LGTM!Also applies to: 165-178, 189-215
160-164: 🎯 Functional CorrectnessDetermine the setup target for explicit
--config. Confirm whethernemo-relay --config path/to/config.toml configwrites the explicit base file. Document the target, or document the intentional difference if setup writes the XDG user configuration instead.crates/cli/README.md (1)
166-173: LGTM!Also applies to: 185-186
docs/configure-plugins/plugin-configuration-files.mdx (1)
221-221: LGTM!Also applies to: 230-230, 242-249, 277-292
docs/integrate-into-frameworks/provider-response-codecs.mdx (1)
114-116: LGTM!Also applies to: 152-153, 220-223
docs/reference/migration-guides.mdx (1)
16-49: LGTM!integrations/coding-agents/README.md (1)
198-201: LGTM!Also applies to: 212-212
Signed-off-by: Will Killian <wkillian@nvidia.com>
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 `@README.md`:
- Around line 114-116: Update the configuration path placeholders to use angle
brackets inside monospace: change the explicit configuration example in
README.md lines 114-116, the resume command in
docs/nemo-relay-cli/basic-usage.mdx line 177, and the repository configuration
command in docs/nemo-relay-cli/codex.mdx lines 174-177 to use
<path/to/config.toml>.
🪄 Autofix
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: 2e8b9c9f-0467-4990-a04d-3a357f634d5d
📒 Files selected for processing (7)
README.mddocs/configure-plugins/model-pricing.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxgo/nemo_relay/plugin_activation_test.go
📜 Review details
⏰ Context from checks skipped due to timeout. (3)
- GitHub Check: Apply PR labels
- GitHub Check: Check / Run
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (32)
**/*.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)
**/*.mdx: In MDX files, top-of-file comments must use JSX comment delimiters ({/*and*/}); do not use HTML comments for MDX SPDX headers.
New or regenerated MDX files must use{/* ... */}for top-of-file SPDX comments.
Files:
docs/configure-plugins/model-pricing.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/configure-plugins/model-pricing.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
**/*: Use release tags in raw Rust-compatible SemVer without a leadingv; tags such asv0.1.0are prohibited.
Use branch prefixesfeat/,fix/,docs/,test/, orrefactor/according to the change purpose.
Every commit in a pull request must include a DCOSigned-off-by:sign-off.
Before submitting a pull request, ensure pre-commit hooks, relevant tests, target-specific builds, documentation updates, and a rebase on the latestmainare complete.
Use commit messages in the formtype: short description, with a valid type and a first line under 72 characters.
Files:
docs/configure-plugins/model-pricing.mdxREADME.mddocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxgo/nemo_relay/plugin_activation_test.godocs/nemo-relay-cli/basic-usage.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/configure-plugins/model-pricing.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If links in documentation change, run
just docs-linkcheck.Use documented public APIs and stable wrapper commands in examples and user-facing documentation; do not rely on internal helpers.
**/*.{md,mdx}: Prefer the documented public API over internal shortcuts in documentation and examples.
Keep package names, repository references, and build commands current.
Contribution workflow documentation must require an issue before external contribution pull requests and note that NVIDIA contributors may use a GitHub or Linear issue.
Update entry-point documentation when examples or reading paths change.
Keep release-process and release-notes guidance in maintainer documentation such asRELEASING.md, rather than user-facing documentation pages orCHANGELOG.md.
Use stable user-facing wrappers at thescripts/root in documentation and examples; reference namespaced helper paths only for internal maintenance documentation.
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pages.
Dynamic plugin manifests in documentation and examples should usecompat.relay = ">=0.5,<1.0"unless deliberately narrower.
Render images, diagrams, tables, and other visual content at representative page widths, ensuring legibility and complete access without clipping; use responsive scaling, reflow, or overflow as appropriate and scope visual styling narrowly.
Dynamic plugin entry pages should link to native, worker, Rust example, Python example, and protocol pages when those pages exist.
Images, diagrams, tables, and custom visual content must remain legible and fully accessible at representative desktop and narrow page widths.
Release-policy documentation must point to GitHub Releases as the only release-history source of truth.
Runjust docswhen the documentation site changes; retain./scripts/build-docs.sh htmlas the compatibility wrapper.
Files:
docs/configure-plugins/model-pricing.mdxREADME.mddocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,mdx,py,go,js,ts}
📄 CodeRabbit inference engine (.agents/skills/maintain-observability/SKILL.md)
Examples and documentation must use each exporter's documented flush/deregister order before shutdown.
Files:
docs/configure-plugins/model-pricing.mdxREADME.mddocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxgo/nemo_relay/plugin_activation_test.godocs/nemo-relay-cli/basic-usage.mdx
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant reference documentation when public behavior or APIs change.
Files:
docs/configure-plugins/model-pricing.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*.{rs,py,go,js,jsx,ts,tsx,c,h,html,md,mdx,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include the appropriate SPDX copyright and Apache-2.0 license header in every source file.
Files:
docs/configure-plugins/model-pricing.mdxREADME.mddocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxgo/nemo_relay/plugin_activation_test.godocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,mdx,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,mdx,rst}: Use title case consistently for technical documentation headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title case.
Format code elements, commands, parameters, package names, expressions, directories, file names, and paths in monospace; represent path placeholders with angle brackets inside monospace.
Format UI buttons, menus, fields, and labels in bold, and separate consecutive UI navigation labels with>.
Use quotation marks for error messages and strings when appropriate, italics for newly introduced terms and publication titles, and plain text for keyboard shortcuts.
Represent GitHub repositories with owner/repository link text, such as[NVIDIA/NeMo](link), rather than generic repository wording.
Introduce every code block with a complete sentence; do not let a code block complete or interrupt the grammar of surrounding prose; use syntax highlighting when supported.
Keep inline method, function, and class references consistent with nearby documentation; omit empty parentheses in prose when no call is shown.
Use descriptive link text matching the destination title when possible; avoid raw URLs, generic anchors, long-sentence links, and unnecessary links that distract from procedures.
Ensure lists have a complete lead-in sentence, more than one item, no more than two levels, parallel construction, one idea or action per item, and appropriate punctuation; use bullets for unordered items and numbers for ordered tasks.
Format definition lists with a bold term followed by a complete, parallel, punctuated definition.
Use tables for reference information, decision support, compatibility matrices, and comparable choices; flag one-row tables, missing captions or lead-ins, sentence-case headers where title case is expected, unexplained empty cells, and code or links that would be clearer as prose.
Write procedure steps as imperative ...
Files:
docs/configure-plugins/model-pricing.mdxREADME.mddocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.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/configure-plugins/model-pricing.mdxREADME.mddocs/configure-plugins/plugin-configuration-files.mdxdocs/nemo-relay-cli/codex.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
README.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as "here" or "read more."
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
README.md
{docs/**/*.md,README.md}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update reference docs, language-binding docs, READMEs, and example documentation when the public surface or expected usage changes.
Files:
README.md
README.md
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands in
README.mdchange, run the targeted docs checks appropriate to the change.Keep
README.mdsynchronized with current workspace members and top-level documentation.
Files:
README.md
**/*.{rs,py,js,jsx,ts,tsx,go,c,h,cc,cpp,md,toml,yml,yaml,sh}
📄 CodeRabbit inference engine (AGENTS.md)
Keep SPDX headers on source, documentation, scripts, and configuration files; the project is Apache-2.0.
Files:
README.mdgo/nemo_relay/plugin_activation_test.go
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update the relevant crate or package README when that package surface changes.
Update relevant package or crate
README.mdfiles when examples or binding guidance changes.
Files:
README.md
**/{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update
README.mdordocs/index.mdwhen documentation entry points change.
Files:
README.md
{README.md,docs/**/*.md,fern/**/*}
📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Update current-version installation commands, package examples, and configuration examples from the old version to
<next-version>where appropriate; leave intentional historical references, generated build output, and third-party attribution entries unchanged.
Files:
README.md
docs/integrate-into-frameworks/**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Update docs if activation or usage changes.
Files:
docs/integrate-into-frameworks/provider-response-codecs.mdx
go/nemo_relay/**/*.go
📄 CodeRabbit inference engine (.agents/skills/test-go-binding/SKILL.md)
go/nemo_relay/**/*.go: Format changed Go packages withcd go/nemo_relay && go fmt ./...
Run Go tests withjust test-goto build and test the NeMo Relay Go binding
Usejust build-gowhen you want an explicit build-only pass or need the artifact for other work
Usejust ci=true test-gowhen you need the CI-style coverage and JUnit path
On macOS, setDYLD_LIBRARY_PATHto the../../target/releasedirectory before running the rawgo testcommand directly
Files:
go/nemo_relay/plugin_activation_test.go
{crates/python/src/py_api/mod.rs,python/nemo_relay/**/*.py,python/nemo_relay/**/*.pyi,go/nemo_relay/**/*.go,crates/node/src/api/**/*.rs}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update the language-native bindings for every exposed surface in Python, Go, and Node.js.
Files:
go/nemo_relay/plugin_activation_test.go
{python/nemo_relay/**/*.py,python/nemo_relay/**/*.pyi,go/nemo_relay/**/*.go}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update language wrapper helpers such as Python wrapper modules, Python type stubs, and Go shorthand packages when the new behavior belongs in those helper layers.
Files:
go/nemo_relay/plugin_activation_test.go
go/nemo_relay/**
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Keep shared plugin helpers in
go/nemo_relayaligned with plugin registration, composition, and lifecycle behavior.
Files:
go/nemo_relay/plugin_activation_test.go
**/*.{rs,py,go,js,ts}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If a language surface changed, always run that language's test target even when Rust core did not change.
**/*.{rs,py,go,js,ts}: When observability configuration or lifecycle is exposed, keep FFI and Python, Go, and Node.js binding-native config objects and subscriber/exporter methods aligned in logical knobs and semantics.
Require every OpenTelemetry endpoint to have a type and nonblank destination; resolveheader_envvalues at activation and reject missing, blank, or duplicate headers.
Concatenate layered ATOF sink, ATIF storage, and OpenTelemetry endpoint lists with higher-precedence entries first.
Preserve correct handling of mark events, start/end events, orphan cases, and span or trajectory fields derived from intended event data.
Run affected Rust tests andjust test-rustwhen event fields change; runjust test-python,just test-go, andjust test-nodewhen binding-native configuration or lifecycle changes.
Files:
go/nemo_relay/plugin_activation_test.go
**/*.{rs,py,js,ts,tsx,go,java,kt,swift}
📄 CodeRabbit inference engine (.agents/skills/add-middleware/SKILL.md)
Add tests covering registration and duplicate names, deregistration and missing names, priority ordering, callback failure policy, scope-local inheritance and cleanup, event payload semantics, immutable mark and scope fields, and parity across affected bindings.
Files:
go/nemo_relay/plugin_activation_test.go
go/**/*.go
📄 CodeRabbit inference engine (AGENTS.md)
Use
PascalCasefor public Go APIs.
Files:
go/nemo_relay/plugin_activation_test.go
**/*.go
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.go: Format Go code withgofmt.
Rungo vet ./...for Go static analysis.
Use GoPascalCasenaming conventions.
Files:
go/nemo_relay/plugin_activation_test.go
**/*.{rs,py,go,js,jsx,ts,tsx,c,h}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.{rs,py,go,js,jsx,ts,tsx,c,h}: Run tests for every language affected by a change; changes to the core Rust crate require tests across all bindings.
UseSONAR_IGNORE_START/SONAR_IGNORE_ENDonly for documented false positives, keep ignored blocks minimal, explain them with a comment, and obtain reviewer sign-off.
Preserve the layered architecture in which Rust provides the core runtime and C FFI, PyO3, and NAPI provide bindings that mirror the full API surface.
Files:
go/nemo_relay/plugin_activation_test.go
go/nemo_relay/**/*
⚙️ CodeRabbit configuration file
go/nemo_relay/**/*: Review Go binding changes for cgo memory ownership, race safety, callback cleanup, idiomatic exported APIs, and parity with Rust/FFI behavior.
Any API change should include focused Go tests and consider race-test behavior.
Files:
go/nemo_relay/plugin_activation_test.go
{crates/**/tests/**,python/tests/**,go/nemo_relay/**/*_test.go}
⚙️ CodeRabbit configuration file
{crates/**/tests/**,python/tests/**,go/nemo_relay/**/*_test.go}: Tests should cover the behavior promised by the changed API surface, including error paths and cross-request isolation where relevant.
Prefer assertions on lifecycle events, scope stacks, middleware ordering, and binding parity over shallow smoke tests.
Files:
go/nemo_relay/plugin_activation_test.go
🧠 Learnings (1)
📚 Learning: 2026-07-28T20:33:25.156Z
Learnt from: willkill07
Repo: NVIDIA/NeMo-Relay PR: 572
File: go/nemo_relay/adaptive_runtime_test.go:214-238
Timestamp: 2026-07-28T20:33:25.156Z
Learning: When adding/adjusting Go unit tests for `BuildCacheRequestFacts` (request-ID validation and related request parsing), set `CacheRequestFactsInput.Provider` to a valid provider in all tests that are intended to isolate request-ID behavior—because `BuildCacheRequestFacts` does not validate `Provider`. Then add separate test coverage for malformed `AnnotatedRequest` JSON so JSON parsing failures are not conflated with `Provider`-related inputs.
Applied to files:
go/nemo_relay/plugin_activation_test.go
🔇 Additional comments (7)
docs/configure-plugins/plugin-configuration-files.mdx (2)
227-230: 📐 Maintainability & Code QualityVerify that
--plugin-config-pathis a public CLI option.If this option remains hidden, remove it from this user-facing page. Document
--config <path/to/config.toml>as the supported explicit configuration path instead. The prior review records that--plugin-config-pathwas hidden.As per coding guidelines, user-facing documentation must use documented public APIs and stable wrapper commands.
#!/bin/bash set -euo pipefail rg -n -C 5 -- '--plugin-config-path|hide\s*=' crates/cli/src/commands/serve.rsSource: Coding guidelines
242-249: LGTM!Also applies to: 374-374, 393-401, 439-439
docs/configure-plugins/model-pricing.mdx (1)
71-81: LGTM!docs/integrate-into-frameworks/provider-response-codecs.mdx (1)
87-97: LGTM!Also applies to: 138-145
docs/nemo-relay-cli/basic-usage.mdx (1)
354-364: LGTM!Also applies to: 377-377
go/nemo_relay/plugin_activation_test.go (2)
624-668: 📐 Maintainability & Code QualityRun the required Go validation.
Before merge, run
cd go/nemo_relay && go fmt ./...,go vet ./..., andjust test-go. Include race-test review because this test changes native plugin activation coverage.As per coding guidelines, Go changes require formatting,
go vet ./..., and affected-language tests. As per path instructions, Go binding changes must usejust test-goand consider race behavior.Sources: Coding guidelines, Path instructions
670-752: LGTM!
|
/merge |
#### Overview Recasts GitHub PR #739 onto a direct `NVIDIA/NeMo-Relay` branch so the updated NVSkills/NVCARPS pull request workflow can run. The content updates the public NeMo Relay user skills for the RELAY-669 follow-up to RELAY-667: get-started guidance now treats repository-local Relay config files as unsupported active configuration while preserving local ATOF and ATIF output artifacts, and the NeMo Flow migration helper reports legacy project-local configuration for manual migration instead of converting it into unsupported Relay project configuration. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Added a get-started guardrail that prevents agents from creating, editing, merging, or trusting repository-local `.nemo-relay/config.toml` and `.nemo-relay/plugins.toml`. - Updated the CLI try-now reference and affected get-started evals to use supported user or explicit configuration only, and to distinguish `.nemo-relay/atof` and `.nemo-relay/atif` output directories from configuration layers. - Updated the NeMo Flow migration skill guidance and helper so legacy `.nemo-flow/config.toml` and `.nemo-flow/plugins.toml` are left unchanged and reported as manual migration items. - Added a migration eval covering repositories with legacy project-local NeMo Flow configuration. - Replayed the final GitHub PR #739 file state onto current `upstream/main` as one signed-off commit on `skills/relay-669-user-skills`. Validation: - `python3 -m py_compile skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py` - `python3` JSON parse for affected eval files - Migration helper dry-run fixture for legacy project config - Migration helper write-mode fixture for legacy project config plus unrelated source/path migration - `.venv/bin/ruff check skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py` - `.venv/bin/ty check skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py` - `.venv/bin/pre-commit run --files skills/nemo-relay-get-started/SKILL.md skills/nemo-relay-get-started/evals/evals.json skills/nemo-relay-get-started/references/cli-try-now.md skills/nemo-relay-migrate-from-flow/SKILL.md skills/nemo-relay-migrate-from-flow/evals/evals.json skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py` - `git diff --check` Known follow-up: `skill-card.md`, `BENCHMARK.md`, and `skill.oms.sig` were not refreshed locally; those should be refreshed through the normal NVSkills publication workflow. #### Where should the reviewer start? Start with `skills/nemo-relay-migrate-from-flow/scripts/migrate_from_nemo_flow.py`, especially the legacy project configuration detection and blocked path rename logic. Then review `skills/nemo-relay-get-started/references/cli-try-now.md` for the user-facing configuration guidance. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: RELAY-669 - Relates to: #720 - Relates to: #739 ## Summary by CodeRabbit * **New Features** * Added safeguards for legacy project-local configuration during NeMo Flow migrations. * Migration previews now identify protected files and provide manual migration guidance. * Secure checks prevent protected files from changing unexpectedly. * **Bug Fixes** * Clarified that repository-local Relay configuration is unsupported and must not be used or modified. * Improved validation and troubleshooting guidance for supported configuration and output files. * Added coverage for safe migration when legacy project configuration is present. * **Documentation** * Updated onboarding, migration, evaluation, benchmark, and verification materials. Authors: - Allan (https://github.com/exactlyallan) - https://github.com/svc-nvskills-signing Approvers: - Will Killian (https://github.com/willkill07) URL: #774
2 participants
Overview
Remove repository-local project configuration and plugin layering as an active NeMo Relay concept. Runtime resolution is now explicit configuration, or XDG user configuration by default, followed by higher-precedence platform system policy.
Details
.nemo-relaydiscovery for gateway configuration, plugin configuration, and dynamic-plugin lifecycle registries./etc/nemo-relayon Unix and%ProgramData%\nemo-relayon Windows, consistently across core plugin discovery, CLI loading and editing, lifecycle state, and doctor output.config.tomlandplugins.toml.doctorto schema version 2 with warning-onlyunsupported_project_filesmigration diagnostics. Legacy project files are neither parsed nor activated.This is an intentional breaking change. The
--projectflags, project/both setup scopes, andconfig --reset --scopeinterface are removed. Existing project configuration and lifecycle files remain on disk but are ignored unless a supported configuration file is selected explicitly.Validation:
RUST_TEST_THREADS=1 just test-rustjust test-python-pluginjust test-pythonjust test-nodejust test-gojust docsjust docs-linkcheckcargo clippy --workspace --all-targets -- -D warningsuv run pre-commit run --all-filesuv run pre-commit run --files README.md docs/configure-plugins/model-pricing.mdx docs/configure-plugins/plugin-configuration-files.mdx docs/integrate-into-frameworks/provider-response-codecs.mdx docs/nemo-relay-cli/basic-usage.mdx docs/nemo-relay-cli/codex.mdx go/nemo_relay/plugin_activation_test.goWhere should the reviewer start?
Start with
crates/core/src/plugin.rsfor the shared platform system-directory resolver and ambient plugin discovery, thencrates/cli/src/configuration/mod.rsfor CLI resolution andcrates/cli/src/diagnostics/mod.rsfor doctor reporting. For the review follow-up, seego/nemo_relay/plugin_activation_test.gofor legacy-project isolation coverage and the configuration/pricing documentation changes.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
Breaking Changes
Bug Fixes
Documentation