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: Add packageManager property #28795

Merged
merged 6 commits into from
Aug 19, 2024

Conversation

tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented Aug 3, 2024

What I did

Add the packageManager property to package.json so that corepack installs an always compatible version of yarn (renovate will update this).

Follow-up would be to use corepack also in ci, if this is desired.

Checklist for Contributors

Testing

Enable corepack and run yarn install. It should use 4.4.0 and if not yet installed, automatically install it.

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.3 MB 76.3 MB 0 B -1.53 0%
initSize 169 MB 169 MB 0 B 0.43 0%
diffSize 92.8 MB 92.8 MB 0 B 0.52 0%
buildSize 7.46 MB 7.46 MB 0 B 0.49 0%
buildSbAddonsSize 1.62 MB 1.62 MB 0 B 1.73 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.3 MB 2.3 MB 0 B 0.32 0%
buildSbPreviewSize 351 kB 351 kB 0 B 1.63 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.46 MB 4.46 MB 0 B 0.69 0%
buildPreviewSize 3 MB 3 MB 0 B 0.39 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 6.6s 14.1s 7.4s -0.3 52.7%
generateTime 19.5s 20.1s 536ms -0.26 2.7%
initTime 16.7s 17s 304ms -0.42 1.8%
buildTime 13.2s 13.6s 384ms 1.42 2.8%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 8.1s 7s -1s -47ms -0.5 -14.8%
devManagerResponsive 5.3s 4.7s -642ms -0.24 -13.5%
devManagerHeaderVisible 815ms 1s 252ms 2.26 🔺23.6%
devManagerIndexVisible 851ms 1.1s 258ms 2.24 🔺23.3%
devStoryVisibleUncached 1.1s 1.2s 123ms -0.16 9.5%
devStoryVisible 850ms 1.1s 257ms 2.19 🔺23.2%
devAutodocsVisible 971ms 813ms -158ms 0.48 -19.4%
devMDXVisible 735ms 660ms -75ms -0.56 -11.4%
buildManagerHeaderVisible 700ms 947ms 247ms 1.96 🔺26.1%
buildManagerIndexVisible 707ms 949ms 242ms 1.95 🔺25.5%
buildStoryVisible 759ms 1s 270ms 1.89 🔺26.2%
buildAutodocsVisible 707ms 681ms -26ms -0.35 -3.8%
buildMDXVisible 631ms 754ms 123ms 1.23 16.3%

Greptile Summary

Added packageManager property to package.json to ensure corepack installs a compatible version of yarn, enhancing consistency across environments.

  • Updated /code/addons/onboarding/package.json to include packageManager property specifying [email protected].
  • Ensures corepack installs the correct yarn version for consistent dependency management.
  • Follow-up action: Consider using corepack in CI for further consistency.

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

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

Copy link

nx-cloud bot commented Aug 3, 2024

☁️ Nx Cloud Report

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

@yannbf
Copy link
Member

yannbf commented Aug 5, 2024

Hey @ndelangen we added and removed the packageManager property many times over the year. Could you chime in here?

@yannbf yannbf added build Internal-facing build tooling & test updates ci:normal labels Aug 5, 2024
@valentinpalkovic valentinpalkovic merged commit 17584a0 into storybookjs:next Aug 19, 2024
52 checks passed
@github-actions github-actions bot mentioned this pull request Aug 19, 2024
11 tasks
@tobiasdiez tobiasdiez deleted the packagemanager branch August 19, 2024 15:25
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.

4 participants