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

Vite: Fix asset warning by externalizing sb-common-assets font #27110

Merged
merged 3 commits into from
May 22, 2024

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented May 13, 2024

Closes #22531

What I did

Externalized ./sb-common-assets/*.woff2 to prevent Vite showing a ./sb-common-assets/fonts.css doesn't exist at build time warning. The assets are copied over to storybook-static during the build.

My first attempt was to externalize ./sb-common-assets/font.css, which failed due to the following issue in Vite: vitejs/vite#8976. Therefore I was forced to replace the CSS import and inline the font-face declarations.

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!

  1. Run a Vite sandbox
  2. yarn build-storybook
  3. The warning ./sb-common-assets/fonts.css doesn't exist at build time, it will remain unchanged to be resolved at runtime shouldn't appear

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>

Copy link

nx-cloud bot commented May 13, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5e67491. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-does-not-exist-at-build-time branch from 903c324 to 61ad788 Compare May 13, 2024 12:56
@valentinpalkovic valentinpalkovic marked this pull request as ready for review May 13, 2024 14:32
@valentinpalkovic valentinpalkovic changed the title Vite: Externalize sb-common-assets font to remove warning Vite: Externalize sb-common-assets font in manager and all builders to remove asset warning May 22, 2024
@valentinpalkovic valentinpalkovic merged commit 59bf7a2 into next May 22, 2024
59 of 62 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-does-not-exist-at-build-time branch May 22, 2024 09:39
@github-actions github-actions bot mentioned this pull request May 22, 2024
25 tasks
@shilman shilman changed the title Vite: Externalize sb-common-assets font in manager and all builders to remove asset warning Vite: Fix asset warning by externalizing sb-common-assets font May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: doesn't exist at build time, it will remain unchanged to be resolved at runtime
2 participants