Skip to content
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

Docs: Use dynamic Vite imports in snippets #26330

Merged
merged 1 commit into from
Mar 5, 2024
Merged

Conversation

JReinhold
Copy link
Contributor

Reacts to #26291 (comment)

What I did

Changed all imports from of Vite in main.ts documentation to be dynamic imports, to minimize the risk that users get a warning about Vite CJS bundles being deprecated.

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

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/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>

@JReinhold JReinhold requested a review from kylegach March 5, 2024 20:12
@JReinhold JReinhold self-assigned this Mar 5, 2024
@JReinhold JReinhold added documentation builder-vite ci:docs Run the CI jobs for documentation checks only. labels Mar 5, 2024
@JReinhold JReinhold marked this pull request as ready for review March 5, 2024 20:12
Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Seems good to me!

Should we include a comment about why the dynamic import is necessary? I trust your judgement there.

@JReinhold JReinhold enabled auto-merge March 5, 2024 20:22
@JReinhold JReinhold disabled auto-merge March 5, 2024 20:22
@JReinhold JReinhold merged commit b314219 into next Mar 5, 2024
21 of 32 checks passed
@JReinhold JReinhold deleted the jeppe/docs-vite-import branch March 5, 2024 20:22
@github-actions github-actions bot mentioned this pull request Mar 6, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builder-vite ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants