Skip to content

test: remove more documentation shape assertions - #9257

Merged
cv merged 2 commits into
mainfrom
test/remove-more-source-shape-tests
Aug 16, 2026
Merged

test: remove more documentation shape assertions#9257
cv merged 2 commits into
mainfrom
test/remove-more-source-shape-tests

Conversation

@cv

@cv cv commented Aug 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove documentation wording, navigation, migration-status, security-review prose, and skill-Markdown mirror tests that duplicate checked-in text. Retain executable coverage for parsers, generators, collectors, policy evaluators, workflow scripts, credential forms, JWTs, prompt integrity, and published-route validation.

Changes

  • Delete 13 documentation and skill mirror suites.
  • Remove prose-only assertions from 10 mixed suites while preserving their behavior tests.
  • Remove the obsolete E2E migration parity watch trigger.
  • Replace the deleted changelog-specific test command with the canonical npm run docs validation in docs/CONTRIBUTING.md.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification: Retained generator, route, workflow, security, and collector tests exercise the stable behavior boundaries.
  • Tests not applicable — justification:
  • Docs updated for user-facing behavior changes
  • Docs not applicable — justification:
  • Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging)
  • Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: Pending reviewer confirmation; no production sensitive-path code changed.
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Documentation Writer Review

  • Documentation writer subagent reviewed the completed changes
  • Result: docs-updated
  • Evidence: docs/CONTRIBUTING.md now uses the canonical npm run docs changelog validation. The complete test-removal diff was reviewed against the writing and documentation style rules.
  • Agent: Pi CLI

DGX Station Hardware Evidence

  • Tested on DGX Station
  • Tested commit:
  • Station profile/scenario:
  • Result:
  • Supporting evidence:

Verification

  • PR description includes a Signed-off-by: line and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run validate:pr passed after refreshing origin/main when hooks were skipped or unavailable
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above — CLI: 3 tests; retained integration suites: 77 tests; dependency collector suites: 48 tests. npm run docs, npm run lint, npm run source-shape:check, and npm run test:projects:check passed.
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result: Not run locally; CI is the broad gate for this test-only deletion pass.
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Carlos Villela cvillela@nvidia.com

Summary by CodeRabbit

  • Documentation

    • Simplified the changelog release-note procedure to use a single documentation command.
    • Removed outdated documentation validation requirements and references tied to retired workflows and guidance.
  • Tests

    • Retired numerous legacy documentation and policy checks covering onboarding, deployment, credentials, monitoring, migrations, dependency upgrades, and platform-specific guidance.
    • Removed related watch-trigger mappings and supporting test utilities.
    • No end-user product behavior or public interfaces changed.

@cv cv self-assigned this Aug 16, 2026
@coderabbitai

coderabbitai Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 443b0eca-9831-4337-b9cc-389e2de7eb5f

📥 Commits

Reviewing files that changed from the base of the PR and between 03fdc7b and f30064c.

📒 Files selected for processing (25)
  • docs/CONTRIBUTING.md
  • src/lib/onboard/docker-driver-gateway-config-auth-contract.test.ts
  • test/changelog-docs.test.ts
  • test/control-ui-config-endpoint-docs.test.ts
  • test/credential-rotation-docs.test.ts
  • test/deepagents-monitoring-published-routes.test.ts
  • test/dependency-upgrade-hermes-variant.test.ts
  • test/dependency-upgrade-skill-security.test.ts
  • test/dependency-upgrade-skill.test.ts
  • test/docs-refactor-ownership.test.ts
  • test/e2e/support/e2e-migration-policy.test.ts
  • test/e2e/support/e2e-migration-source-of-truth.test.ts
  • test/generate-platform-docs.test.ts
  • test/headless-server-docs.test.ts
  • test/helpers/vitest-watch-triggers.ts
  • test/hermes-api-key-lifecycle-docs.test.ts
  • test/internal-commands-docs.test.ts
  • test/issue-4434-error-fields.test.ts
  • test/maintainer-fix-e2e-policy.test.ts
  • test/policy-roundtrip-docs.test.ts
  • test/pr-comparator-render-verdict.test.ts
  • test/repro-5324-operator-admin-approval-docs.test.ts
  • test/starter-prompt-docs.test.ts
  • test/sync-agent-variant-docs.test.ts
  • test/vitest-watch-triggers.test.ts
💤 Files with no reviewable changes (24)
  • test/repro-5324-operator-admin-approval-docs.test.ts
  • test/dependency-upgrade-skill.test.ts
  • test/docs-refactor-ownership.test.ts
  • test/hermes-api-key-lifecycle-docs.test.ts
  • test/dependency-upgrade-hermes-variant.test.ts
  • test/policy-roundtrip-docs.test.ts
  • test/changelog-docs.test.ts
  • test/e2e/support/e2e-migration-policy.test.ts
  • test/pr-comparator-render-verdict.test.ts
  • test/dependency-upgrade-skill-security.test.ts
  • test/sync-agent-variant-docs.test.ts
  • test/e2e/support/e2e-migration-source-of-truth.test.ts
  • test/headless-server-docs.test.ts
  • test/vitest-watch-triggers.test.ts
  • test/deepagents-monitoring-published-routes.test.ts
  • test/generate-platform-docs.test.ts
  • test/internal-commands-docs.test.ts
  • test/helpers/vitest-watch-triggers.ts
  • test/starter-prompt-docs.test.ts
  • test/credential-rotation-docs.test.ts
  • test/maintainer-fix-e2e-policy.test.ts
  • test/control-ui-config-endpoint-docs.test.ts
  • src/lib/onboard/docker-driver-gateway-config-auth-contract.test.ts
  • test/issue-4434-error-fields.test.ts

Included review availability: Your plan includes up to 12 reviews per rolling hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The pull request removes multiple documentation and policy contract tests, removes related Vitest watch mappings and unused imports, and updates the release-note procedure to use only npm run docs.

Changes

Documentation contract cleanup

Layer / File(s) Summary
Release-note verification update
docs/CONTRIBUTING.md, test/changelog-docs.test.ts
The release-note procedure no longer runs the targeted changelog test. The changelog documentation test file was deleted.
Gateway authentication contract cleanup
src/lib/onboard/docker-driver-gateway-config-auth-contract.test.ts, test/control-ui-config-endpoint-docs.test.ts, test/credential-rotation-docs.test.ts, test/hermes-api-key-lifecycle-docs.test.ts
Gateway authentication guidance and related endpoint, credential-rotation, and API-key lifecycle documentation checks were removed. JWT and configuration contract tests remain.
Documentation test and watch cleanup
test/deepagents-monitoring-published-routes.test.ts, test/dependency-upgrade-*.test.ts, test/docs-refactor-ownership.test.ts, test/e2e/support/e2e-migration-*.test.ts, test/generate-platform-docs.test.ts, test/headless-server-docs.test.ts, test/helpers/vitest-watch-triggers.ts, test/internal-commands-docs.test.ts, test/issue-4434-error-fields.test.ts, test/maintainer-fix-e2e-policy.test.ts, test/policy-roundtrip-docs.test.ts, test/pr-comparator-render-verdict.test.ts, test/starter-prompt-docs.test.ts, test/sync-agent-variant-docs.test.ts, test/vitest-watch-triggers.test.ts
Additional documentation, migration, policy, monitoring, rendering, guard, and onboarding checks were deleted. The parity-inventory watch trigger and its expected mapping were also removed.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: 🟡 Moderate · up to f3006

This PR removes redundant documentation assertions while retaining executable behavior coverage and does not identify a production behavior change. Merge readiness remains incomplete until the required sensitive-path review or maintainer waiver is recorded.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the removal of documentation shape and mirror assertions, which is the main change in the pull request.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch test/remove-more-source-shape-tests

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

@github-code-quality

github-code-quality Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Code Coverage Overview

Languages: TypeScript

TypeScript / code-coverage/plugin

The overall coverage in commit 39ae0cc in the test/remove-more-sou... branch remains at 96%, unchanged from commit 03fdc7b in the main branch.


Updated August 16, 2026 21:27 UTC

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings reported

Advisor assessment: No blocking advisor findings reported
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions

Model lanes

  • GPT-5.6 Terra (primary): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Nemotron 3 Ultra (second opinion): Failed

Second-opinion terminology and E2E selections are advisory. Live E2E does not run automatically for pull requests.

E2E guidance

Advisory only. A maintainer can dispatch the default E2E suite for the commit under review.

Recommended E2E: None

Manual-only E2E: cloud-onboard
The manual PR workflow does not run these selectors for the commit under review. Run them from reviewed code on main.

Workflow run details

This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge.

@senthilr-nv senthilr-nv left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maintainer review — latest PR commit f30064c778cf73540a3260815f0e8bba788d56e2

The prose-mirror cleanup is directionally sound, but two classes of deleted tests enforce behavior and safety contracts that npm run docs does not replace.

  1. Changelog release invariants lose their only validator. test/changelog-docs.test.ts checks MDX-compatible SPDX syntax, release ordering and uniqueness, completeness of migrated history, literal command names, the absence of variant wrappers, and root-absolute links. The npm run docs chain generates shared content, checks generated files and routes, and runs Fern validation; it does not enforce those release-history invariants. Keep these checks in a focused semantic validator, or move them into a canonical script invoked by npm run docs, before changing docs/CONTRIBUTING.md to call the latter the replacement.
  2. Security guidance loses behavior-linked regression evidence. The deleted operator-admin, credential-rotation, and policy-roundtrip suites protect concrete safety boundaries: no automatic operator.admin approval and exact-request recovery, keeping replacement credentials out of command text, narrow MCP routes, and preserving SSRF protection. Rendering and route checks do not verify those claims. Retain these safety assertions or replace them with an authoritative semantic validator tied to the corresponding behavior contracts.

This makes the current statement that retained security and documentation tests cover the stable boundaries inaccurate. The documentation receipt is current, and the product/runtime surface is otherwise unchanged. Cross-issue search found no competing or adjacent accepted scope. I did not run local validation, approve, or merge.

@cv
cv merged commit 00fd0fa into main Aug 16, 2026
80 of 85 checks passed
@cv
cv deleted the test/remove-more-source-shape-tests branch August 16, 2026 21:46
@wscurran wscurran added the refactor PR restructures code without intended behavior change label Aug 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactor PR restructures code without intended behavior change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants