Core: Disable component manifest by default#34408
Conversation
|
View your CI Pipeline Execution ↗ for commit fe28f48
☁️ Nx Cloud last updated this comment at |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe PR changes the default value of the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
Comment |
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)
code/core/src/core-server/presets/common-preset.ts (1)
205-212:⚠️ Potential issue | 🟠 MajorAdd explicit migration guidance for this default flip.
Line 211 changes
componentsManifestto opt-in, which disables manifest write/serve paths by default in both build and dev. That can silently break existing MCP/tooling workflows after upgrade unless users explicitly setfeatures.componentsManifest: true. Please add a migration note/release note callout with the opt-in snippet.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@code/core/src/core-server/presets/common-preset.ts` around lines 205 - 212, The change to the default in the exported features PresetProperty (function named features) flips componentsManifest to opt-in and can break downstream MCP/tooling; add a migration/release-note callout documenting the flip and include an explicit opt-in example (tell users to set features.componentsManifest: true in their preset/config) and where to apply it (dev and build configs or the same preset override) so users can restore manifest write/serve behavior; update the changelog/release notes and any migration guide files to contain that snippet and a brief one-line explanation referencing the features PresetProperty and componentsManifest flag.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@code/core/src/core-server/presets/common-preset.ts`:
- Around line 205-212: The change to the default in the exported features
PresetProperty (function named features) flips componentsManifest to opt-in and
can break downstream MCP/tooling; add a migration/release-note callout
documenting the flip and include an explicit opt-in example (tell users to set
features.componentsManifest: true in their preset/config) and where to apply it
(dev and build configs or the same preset override) so users can restore
manifest write/serve behavior; update the changelog/release notes and any
migration guide files to contain that snippet and a brief one-line explanation
referencing the features PresetProperty and componentsManifest flag.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c344f351-b758-4132-83b9-03d11be5eb01
📒 Files selected for processing (4)
code/core/src/core-server/presets/common-preset.tscode/core/src/types/modules/core-common.tsdocs/_snippets/main-config-features-components-manifest.mddocs/api/main-config/main-config-features.mdx
|
We should have some kind of prominent note in the changelog for users upgrading from 10.3.x since this is technically a breaking bugfix. |
…ifest-defaults Core: Disable component manifest by default (cherry picked from commit b224bef)
…ifest-defaults Core: Disable component manifest by default (cherry picked from commit b224bef)
Closes #
What I did
As title states
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated 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
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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
Documentation
Chores