-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Maintenance: Split renderers preview entrypoints #24623
Merged
Merged
Conversation
This file contains 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
ndelangen
requested review from
kasperpeulen,
JReinhold,
shilman and
valentinpalkovic
as code owners
October 30, 2023 19:50
ndelangen
added
maintenance
User-facing maintenance tasks
performance issue
ci:normal
labels
Oct 30, 2023
ndelangen
commented
Oct 31, 2023
tmeasday
approved these changes
Nov 1, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like I want the name "preview" in entry-docs
somewhere. It's a "preview annotations file added for docs". Entry is ambiguous, as (a) you can have other entries, e.g. in the manager, and (b) it doesn't indicate the special preview annotations handling of exports.
26 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
When doing research how to optimize storybook compile time (
sb build
), @kasperpeulen discovered that we add docs related preview code even if addon docs isn't used.This PR splits the injected code into 2 parts and ensures the docs related part is only injected when addon docs is active.
I renamed the
config.ts
(old naming scheme) file toentry-preview.ts
andentry-docs.ts
.At first I had
preview.ts
andpreview-docs.ts
, but I found it hard to distinguish between entries by addons that were also calledpreview
.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
.mdx
extension for storiesaddon-essentials
(and optionallyaddon-docs
too)autodocs: 'tag'
)rollup-plugin-visualizer
inmain.ts
:"entry-docs"
should NOT be there.Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/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 canary-release-pr.yml --field pr=<PR_NUMBER>