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

Build: Alias sb-original/image-context in internal Storybook config #30133

Merged
merged 1 commit into from
Dec 24, 2024

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Dec 24, 2024

What I did

Updated the Vite config for our internal Storybook to include an alias for sb-original/image-context. This workaround is required because Vite dependency optimization includes @storybook/experimental-nextjs-vite in our bundle despite us not actually using this package. This is an optimization intended for end-users.

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-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 canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Added an alias for 'sb-original/image-context' in the Vite configuration to optimize development builds by preventing unnecessary bundling of @storybook/experimental-nextjs-vite.

  • Added path alias in .storybook/main.ts to resolve sb-original/image-context during development
  • Prevents Vite from including unused @storybook/experimental-nextjs-vite package in development bundle
  • Change only affects development builds, not production

@ghengeveld ghengeveld added build Internal-facing build tooling & test updates ci:normal labels Dec 24, 2024
@yannbf yannbf merged commit 44e789c into next Dec 24, 2024
4 of 11 checks passed
@yannbf yannbf deleted the alias-sb-original-image-context branch December 24, 2024 10:03
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

@@ -4,6 +4,7 @@ import type { StorybookConfig } from '../frameworks/react-vite';

const componentsPath = join(__dirname, '../core/src/components');
const managerApiPath = join(__dirname, '../core/src/manager-api');
const imageContextPath = join(__dirname, '..//frameworks/nextjs/src/image-context.ts');
Copy link
Contributor

Choose a reason for hiding this comment

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

syntax: double forward slash in path '..//frameworks/nextjs/src/image-context.ts'

@yannbf yannbf changed the title Core: Alias sb-original/image-context in internal Storybook config Build: Alias sb-original/image-context in internal Storybook config Dec 24, 2024
Copy link

nx-cloud bot commented Dec 24, 2024

View your CI Pipeline Execution ↗ for commit 5a7af57.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 7s View ↗

☁️ Nx Cloud last updated this comment at 2024-12-24 10:05:47 UTC

@github-actions github-actions bot mentioned this pull request Dec 24, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:normal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants