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

CPC: Direct dependencies on shim packages in renderers #28599

Merged
merged 5 commits into from
Jul 15, 2024

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Jul 15, 2024

Closes #

What I did

I added a few shimmed packages to all renderers, so hopefully when users upgrade to 8.2, whilst using yet not depending on said packages, storybook does not break.

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>

name before after diff %
createTime 6.4s 20.5s 14s 🔺68.5%
generateTime 21s 22.6s 1.6s 🔺7.2%
initTime 22.2s 22.7s 541ms 2.4%
createSize 0 B 0 B 0 B -
generateSize 76.5 MB 76.5 MB 6.19 kB 0%
initSize 198 MB 198 MB 20.1 kB 0%
diffSize 121 MB 121 MB 14 kB 0%
buildTime 14.2s 13.9s -289ms -2.1%
buildSize 7.59 MB 7.59 MB 0 B 0%
buildSbAddonsSize 1.63 MB 1.63 MB 0 B 0%
buildSbCommonSize 195 kB 195 kB 0 B 0%
buildSbManagerSize 2.3 MB 2.3 MB 0 B 0%
buildSbPreviewSize 349 kB 349 kB 0 B 0%
buildStaticSize 0 B 0 B 0 B -
buildPrebuildSize 4.47 MB 4.47 MB 0 B 0%
buildPreviewSize 3.12 MB 3.12 MB 0 B 0%
testBuildTime 0ms 0ms 0ms -
testBuildSize 0 B 0 B 0 B -
testBuildSbAddonsSize 0 B 0 B 0 B -
testBuildSbCommonSize 0 B 0 B 0 B -
testBuildSbManagerSize 0 B 0 B 0 B -
testBuildSbPreviewSize 0 B 0 B 0 B -
testBuildStaticSize 0 B 0 B 0 B -
testBuildPrebuildSize 0 B 0 B 0 B -
testBuildPreviewSize 0 B 0 B 0 B -
devPreviewResponsive 8s 7.9s -187ms -2.4%
devManagerResponsive 5.4s 5.3s -26ms -0.5%
devManagerHeaderVisible 770ms 761ms -9ms -1.2%
devManagerIndexVisible 802ms 797ms -5ms -0.6%
devStoryVisibleUncached 1.1s 1.3s 161ms 🔺12.2%
devStoryVisible 825ms 823ms -2ms -0.2%
devAutodocsVisible 671ms 673ms 2ms 0.3%
devMDXVisible 702ms 734ms 32ms 4.4%
buildManagerHeaderVisible 737ms 819ms 82ms 🔺10%
buildManagerIndexVisible 742ms 821ms 79ms 🔺9.6%
buildStoryVisible 789ms 869ms 80ms 🔺9.2%
buildAutodocsVisible 720ms 702ms -18ms -2.6%
buildMDXVisible 625ms 656ms 31ms 4.7%

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.

PR Summary

  • Added @storybook/components, @storybook/manager-api, @storybook/preview-api, and @storybook/theming to dependencies in /code/renderers/html/package.json
  • Added same shim packages to /code/renderers/preact/package.json
  • Updated /code/renderers/react/package.json with the same shim dependencies
  • Modified /code/renderers/server/package.json to include these shim packages
  • Added shim dependencies to /code/renderers/svelte/package.json
  • Updated /code/renderers/vue3/package.json with the same shim packages
  • Added shim packages to /code/renderers/web-components/package.json

7 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Jul 15, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5316210. 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.

Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

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

LGTM

I was thinking that we could also add those to addon-essentials, but this is probably safer

@ndelangen ndelangen added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jul 15, 2024
@ndelangen ndelangen merged commit b47b346 into next Jul 15, 2024
56 of 57 checks passed
@ndelangen ndelangen deleted the norbert/cpc-add-shim-dependencies-to-renderers branch July 15, 2024 11:00
shilman pushed a commit that referenced this pull request Jul 16, 2024
…dencies-to-renderers

CPC: Direct dependencies on shim packages in renderers
(cherry picked from commit b47b346)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
angular bug ci:normal core html lit patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch preact react server stencil svelte upgrade:8.x upgrade:8.2 vue vue3 web-components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants