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: Fix type usage in renderers #28745

Merged
merged 1 commit into from
Jul 29, 2024
Merged

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Jul 29, 2024

Closes #28728

What I did

As the issue describes, there are places after #27039 that still referenced consolidated packages.
This is wrong, and is addressed in this PR.

The reason this happened was due to CPC taking a long time to complete, and other PRs happened to parallel and were merged after CPC.

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 z %
createSize 0 B 0 B 0 B - -
generateSize 76.4 MB 76.4 MB 0 B -0.59 0%
initSize 198 MB 198 MB 0 B 2.34 0%
diffSize 122 MB 122 MB 0 B 2.71 0%
buildSize 7.6 MB 7.6 MB 0 B 4.36 0%
buildSbAddonsSize 1.63 MB 1.63 MB 0 B 4.36 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 4.36 0%
buildPreviewSize 3.12 MB 3.12 MB 0 B - 0%
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 - -
name before after diff z %
createTime 7.8s 20.7s 12.8s 1.01 62.1%
generateTime 23.3s 21.9s -1s -348ms -0.14 -6.1%
initTime 22.1s 21.1s -1s -31ms -0.74 -4.9%
buildTime 14.3s 12.6s -1s -794ms -2.28 🔰-14.2%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 8.4s 8.9s 455ms 0.05 5.1%
devManagerResponsive 5.6s 5.6s 87ms -0.28 1.5%
devManagerHeaderVisible 899ms 837ms -62ms -0.3 -7.4%
devManagerIndexVisible 939ms 871ms -68ms -0.26 -7.8%
devStoryVisibleUncached 1.4s 1.4s -53ms -0.15 -3.8%
devStoryVisible 973ms 898ms -75ms -0.28 -8.4%
devAutodocsVisible 796ms 746ms -50ms -0.41 -6.7%
devMDXVisible 786ms 744ms -42ms -0.18 -5.6%
buildManagerHeaderVisible 855ms 829ms -26ms -0.05 -3.1%
buildManagerIndexVisible 905ms 830ms -75ms -0.1 -9%
buildStoryVisible 915ms 886ms -29ms -0.05 -3.3%
buildAutodocsVisible 888ms 688ms -200ms -0.66 -29.1%
buildMDXVisible 725ms 662ms -63ms -0.6 -9.5%

Greptile Summary

Updated import paths for BaseAnnotations in various renderer mount.ts files to ensure correct internal type usage.

  • React Renderer: Updated code/renderers/react/src/mount.ts to import BaseAnnotations from storybook/internal/types.
  • Svelte Renderer: Modified code/renderers/svelte/src/mount.ts to use storybook/internal/types for BaseAnnotations.
  • Vue3 Renderer: Changed code/renderers/vue3/src/mount.ts to import BaseAnnotations from storybook/internal/types.

Ensure the new import paths are correct and all dependencies are resolved.

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.

LGTM

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

@ndelangen ndelangen added bug react patch:yes Bugfix & documentation PR that need to be picked to main branch core svelte vue3 labels Jul 29, 2024
@ndelangen ndelangen self-assigned this Jul 29, 2024
Copy link

nx-cloud bot commented Jul 29, 2024

☁️ Nx Cloud Report

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

@ndelangen ndelangen requested a review from shilman July 29, 2024 11:25
@ndelangen ndelangen merged commit 54b4af3 into next Jul 29, 2024
58 of 65 checks passed
@ndelangen ndelangen deleted the norbert/cpc-fix-types-usage branch July 29, 2024 13:54
storybook-bot pushed a commit that referenced this pull request Jul 29, 2024
CPC: Fix type usage in renderers
(cherry picked from commit 54b4af3)
@github-actions github-actions bot mentioned this pull request Jul 29, 2024
6 tasks
storybook-bot pushed a commit that referenced this pull request Jul 29, 2024
CPC: Fix type usage in renderers
(cherry picked from commit 54b4af3)
storybook-bot pushed a commit that referenced this pull request Jul 29, 2024
CPC: Fix type usage in renderers
(cherry picked from commit 54b4af3)
storybook-bot pushed a commit that referenced this pull request Jul 29, 2024
CPC: Fix type usage in renderers
(cherry picked from commit 54b4af3)
storybook-bot pushed a commit that referenced this pull request Jul 31, 2024
CPC: Fix type usage in renderers
(cherry picked from commit 54b4af3)
storybook-bot pushed a commit that referenced this pull request Jul 31, 2024
CPC: Fix type usage in renderers
(cherry picked from commit 54b4af3)
storybook-bot pushed a commit that referenced this pull request Jul 31, 2024
CPC: Fix type usage in renderers
(cherry picked from commit 54b4af3)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal core 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 react svelte vue3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: @storybook/types issues
2 participants