Skip to content

chore(guardrails)!: remove python-only guardrails example plugin#198

Merged
rapids-bot[bot] merged 6 commits into
NVIDIA:mainfrom
afourniernv:remove-example-guardrails-plugin
Jun 7, 2026
Merged

chore(guardrails)!: remove python-only guardrails example plugin#198
rapids-bot[bot] merged 6 commits into
NVIDIA:mainfrom
afourniernv:remove-example-guardrails-plugin

Conversation

@afourniernv

@afourniernv afourniernv commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Overview

Remove the old NeMo Guardrails example plugin from examples/ and clean up the remaining docs and test references to that deprecated example surface.

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

This PR:

  • removes examples/nemoguardrails and its bundled agent/example assets
  • removes the dedicated Python test for the example plugin
  • deletes the old docs/build-plugins/nemoguardrails.mdx page
  • trims the last Build Plugins docs link that pointed to the removed example page
  • removes obsolete Fern cleanup rewrite rules that referenced the deleted example files

Validation:

  • uv run pre-commit run --files docs/build-plugins/about.mdx scripts/docs/fern_cleanup.py docs/build-plugins/nemoguardrails.mdx examples/nemoguardrails/README.md examples/nemoguardrails/example/agent_example.py examples/nemoguardrails/example/example_config.yml examples/nemoguardrails/example/plugin.py examples/nemoguardrails/example/rails/config.yml python/tests/test_nemoguardrails_example_plugin.py
  • uv run pre-commit run --all-files

Pre-commit caveat:

  • full pre-commit only failed docs markdown linkcheck because this environment could not reach several external public URLs; the cleanup branch did not leave any example-plugin references behind

Where should the reviewer start?

Start with:

  • docs/build-plugins/about.mdx
  • scripts/docs/fern_cleanup.py
  • the deleted examples/nemoguardrails tree

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • Relates to: none

Summary by CodeRabbit

Release Notes

  • Documentation

    • Removed NeMo Guardrails Example Plugin documentation page and related guide references.
  • Chores

    • Removed NeMo Guardrails example code and associated test suite.

Signed-off-by: Alex Fournier <afournier@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 1, 2026

Copy link
Copy Markdown

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

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

This PR removes the NeMo Guardrails example plugin from the repository. The removal includes example code files, configuration files, test suite, documentation pages, and documentation build script references.

Changes

NeMo Guardrails example removal

Layer / File(s) Summary
Example configuration and implementation removal
examples/nemoguardrails/example/rails/config.yml
Guardrails configuration file containing model selections, input/output rail flow definitions, and prompt templates is deleted.
Documentation link and reference cleanup
scripts/docs/fern_cleanup.py
Removed link replacement entries for NeMo Guardrails example files from the Fern documentation cleanup mapping, so those specific documentation paths are no longer rewritten.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed Description includes all required template sections with comprehensive details: overview with confirmations, detailed list of changes, guidance for reviewers, and related issues reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed Title follows Conventional Commits format with type 'chore', scope 'guardrails', breaking change indicator '!', and concise imperative summary under 72 characters.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added size:XL PR is extra large Maintenance CI or Build or general repository maintenance lang:python PR changes/introduces Python code labels Jun 1, 2026
@willkill07 willkill07 added this to the 0.4 milestone Jun 2, 2026
@afourniernv

Copy link
Copy Markdown
Collaborator Author

/ok to test 8310378

@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown

@afourniernv

Copy link
Copy Markdown
Collaborator Author

/ok to test d22ecf2

@afourniernv afourniernv marked this pull request as ready for review June 7, 2026 15:55
@afourniernv afourniernv requested a review from a team as a code owner June 7, 2026 15:55
@willkill07 willkill07 changed the title chore: remove guardrails example plugin chore!(guardrails): remove python-only guardrails example plugin Jun 7, 2026
@github-actions github-actions Bot removed the Maintenance CI or Build or general repository maintenance label Jun 7, 2026
@willkill07 willkill07 changed the title chore!(guardrails): remove python-only guardrails example plugin chore(guardrails)!: remove python-only guardrails example plugin Jun 7, 2026
@github-actions github-actions Bot added Maintenance CI or Build or general repository maintenance breaking PR introduces a breaking change labels Jun 7, 2026
@afourniernv

Copy link
Copy Markdown
Collaborator Author

/merge

@rapids-bot rapids-bot Bot merged commit d966d26 into NVIDIA:main Jun 7, 2026
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking PR introduces a breaking change lang:python PR changes/introduces Python code Maintenance CI or Build or general repository maintenance size:XL PR is extra large

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants