docs(e2e): keep migration state in issues - #4649
Merged
Merged
Conversation
This was referenced Jun 2, 2026
Contributor
📝 WalkthroughWalkthroughThe PR removes in-repository migration inventory tracking and shifts state management to external GitHub issues/PRs. It updates E2E scenario documentation to reflect this policy, removes the migration inventory TypeScript file entirely, and adds test assertions to enforce that migration state is tracked externally and not stored in the repository. ChangesMigration Inventory Removal and External Tracking Policy
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
This was referenced Jun 2, 2026
Closed
Closed
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorBase: Required scenario E2E
Optional scenario E2E
Relevant changed files
|
Contributor
PR Review AdvisorFindings: 0 needs attention, 2 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
Since last review detailsCurrent findings:
This is an automated advisory review. A human maintainer must make the final merge decision. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
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 `@test/e2e-scenario/framework-tests/e2e-migration-inventory-lock.test.ts`:
- Around line 23-30: The test "documents that migration state lives in issues
and PRs" currently only asserts README contains a generic phrase; update it to
explicitly assert that README.md still mentions "GitHub issues and pull
requests" (or the exact guidance string used in MIGRATION_DOC) so it fails if
the README loses the issues/PRs guidance — locate the test (it(...) in
e2e-migration-inventory-lock.test.ts), use the same read(README_DOC) call and
add an expect(readme).toContain("GitHub issues and pull requests") (or match the
exact wording used in MIGRATION_DOC) to tighten the assertion.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: ff33fc6d-cf35-4dd5-8880-7dd26b2b4fd0
📒 Files selected for processing (5)
test/e2e-scenario/docs/MIGRATION.mdtest/e2e-scenario/docs/README.mdtest/e2e-scenario/framework-tests/e2e-migration-inventory-lock.test.tstest/e2e-scenario/framework-tests/e2e-scenario-registry.test.tstest/e2e-scenario/scenarios/migration-inventory.ts
💤 Files with no reviewable changes (2)
- test/e2e-scenario/scenarios/migration-inventory.ts
- test/e2e-scenario/framework-tests/e2e-scenario-registry.test.ts
Comment on lines
+23
to
30
| it("documents that migration state lives in issues and PRs", () => { | ||
| const migration = read(MIGRATION_DOC); | ||
| const readme = read(README_DOC); | ||
|
|
||
| expect(runSource).not.toContain("migration-inventory"); | ||
| expect(migration).toMatch(/tracked\s+outside the repository/); | ||
| expect(migration).toContain("GitHub issues and pull requests"); | ||
| expect(readme).toMatch(/Migration status is tracked outside the repository/); | ||
| }); |
Contributor
There was a problem hiding this comment.
Assert the README still points to issues/PRs.
This test only checks that README.md says migration status is tracked "outside the repository". It would still pass if the README lost the issue/PR guidance that this PR is trying to preserve.
Suggested tightening
it("documents that migration state lives in issues and PRs", () => {
const migration = read(MIGRATION_DOC);
const readme = read(README_DOC);
expect(migration).toMatch(/tracked\s+outside the repository/);
expect(migration).toContain("GitHub issues and pull requests");
expect(readme).toMatch(/Migration status is tracked outside the repository/);
+ expect(readme).toMatch(/parent epic/i);
+ expect(readme).toMatch(/pull requests?/i);
});📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| it("documents that migration state lives in issues and PRs", () => { | |
| const migration = read(MIGRATION_DOC); | |
| const readme = read(README_DOC); | |
| expect(runSource).not.toContain("migration-inventory"); | |
| expect(migration).toMatch(/tracked\s+outside the repository/); | |
| expect(migration).toContain("GitHub issues and pull requests"); | |
| expect(readme).toMatch(/Migration status is tracked outside the repository/); | |
| }); | |
| it("documents that migration state lives in issues and PRs", () => { | |
| const migration = read(MIGRATION_DOC); | |
| const readme = read(README_DOC); | |
| expect(migration).toMatch(/tracked\s+outside the repository/); | |
| expect(migration).toContain("GitHub issues and pull requests"); | |
| expect(readme).toMatch(/Migration status is tracked outside the repository/); | |
| expect(readme).toMatch(/parent epic/i); | |
| expect(readme).toMatch(/pull requests?/i); | |
| }); |
🤖 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 `@test/e2e-scenario/framework-tests/e2e-migration-inventory-lock.test.ts`
around lines 23 - 30, The test "documents that migration state lives in issues
and PRs" currently only asserts README contains a generic phrase; update it to
explicitly assert that README.md still mentions "GitHub issues and pull
requests" (or the exact guidance string used in MIGRATION_DOC) so it fails if
the README loses the issues/PRs guidance — locate the test (it(...) in
e2e-migration-inventory-lock.test.ts), use the same read(README_DOC) call and
add an expect(readme).toContain("GitHub issues and pull requests") (or match the
exact wording used in MIGRATION_DOC) to tighten the assertion.
prekshivyas
approved these changes
Jun 3, 2026
prekshivyas
left a comment
prekshivyas
left a comment
Collaborator
There was a problem hiding this comment.
Approving. Direction is right and the diff is clean.
Non-blocking nit: the hygiene test in e2e-migration-inventory-lock.test.ts only checks the "tracked outside the repository" string. Worth tightening to assert MIGRATION.md still references #3588 (parent epic) and README.md still points to it, so the policy's actual intent — pointing readers somewhere — is what's guarded. CodeRabbit's line-30 nit captures the same idea. Happy if you address it here or as a follow-up.
This was referenced Jun 3, 2026
12 tasks
12 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Move mutable E2E migration tracking out of repository-owned docs and source files so current state lives in the issues and PRs that own the work. This keeps repo docs focused on durable framework guidance and prevents stale per-script status tables from lingering.
Related Issue
Relates to #3588, #4357, and #4378.
Changes
test/e2e-scenario/docs/MIGRATION.mdwith a policy that points current tracking to GitHub issues and PRs.test/e2e-scenario/docs/README.mdto describe durable framework inputs and avoid repo-local migration status tracking.test/e2e-scenario/scenarios/migration-inventory.tsand the tests that depended on it as a mutable status ledger.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Signed-off-by: Carlos Villela cvillela@nvidia.com
Summary by CodeRabbit
Documentation
Tests