Guide: Hide TourGuide as soon as tests start

[ghengeveld]

What I did

Fixed the onboarding tour for testing to not stick around after doing what you're asked to do.

Screen.Recording.2026-01-19.at.17.06.39.mov

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

Caution

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

• Bug Fixes
  • Tour Guide component now properly clears during onboarding sequence.
  • Onboarding checklist progression timing adjusted to respond to test runner state changes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[nx-cloud]

View your CI Pipeline Execution ↗ for commit b90fa5a

Command	Status	Duration	Result
nx run-many -t compile,check,knip,test,pretty-d...	✅ Succeeded	9m 52s	View ↗

---

☁️ Nx Cloud last updated this comment at 2026-01-19 16:37:53 UTC

[coderabbitai]

📝 Walkthrough

Walkthrough

The TourGuide component's render method now accepts nullable props and conditionally renders based on their presence. The test runner trigger in the onboarding checklist is updated to dismiss the tour when the test state becomes running instead of waiting for completion.

Changes

Cohort / File(s)	Summary
TourGuide component signature code/core/src/manager/components/TourGuide/TourGuide.tsx	Updated render method to accept null props with conditional rendering logic that returns null when props are not provided, while preserving onComplete and onDismiss behavior for valid props.
Onboarding checklist trigger code/core/src/shared/checklist-store/checklistData.tsx	Changed test runner subscription handler to trigger when test provider state transitions to running instead of succeeded, calling TourGuide.render(null) to dismiss the tour earlier in the onboarding flow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Core: Fix Checklist behavior with hidden sidebar #33556: Modifies the checklist "Run Tests" action and the timing of when TourGuide is rendered/dismissed during the onboarding flow.

✨ Finishing touches

• 📝 Generate docstrings

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

---

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

[storybook-app-bot]

Package Benchmarks

^{Commit: b90fa5a, ran on 19 January 2026 at 16:35:43 UTC}

The following packages have significant changes to their size or dependencies:

@storybook/react-native-web-vite

	Before	After	Difference
Dependency count	159	159	0
Self size	30 KB	30 KB	🎉 -10 B 🎉
Dependency size	23.00 MB	23.12 MB	🚨 +115 KB 🚨
Bundle Size Analyzer	Link	Link

@storybook/cli

	Before	After	Difference
Dependency count	183	183	0
Self size	775 KB	775 KB	🚨 +139 B 🚨
Dependency size	67.38 MB	67.46 MB	🚨 +79 KB 🚨
Bundle Size Analyzer	Link	Link

@storybook/codemod

	Before	After	Difference
Dependency count	176	176	0
Self size	30 KB	30 KB	🎉 -40 B 🎉
Dependency size	65.95 MB	66.03 MB	🚨 +79 KB 🚨
Bundle Size Analyzer	Link	Link