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

CLI: Automigration for upgrading storybook related dependencies #26377

Merged

Conversation

ndelangen
Copy link
Member

Closes #25731

What I did

This automigration will only run if one of the following is true:

  • The user upgrades to the latest version of storybook
  • The automigration script is called with this specific automigration targetted:
    yarn sb automigrate upgradeStorybookRelatedDependencies

The auto migration performs the following:

  1. It looks for packages with storybook in their name. This matches packages such as:
    • eslint-plugin-storybook
    • @storybook/addon-designs
    • @chromatic-com/storybook
  2. It looks for packages who have dependencies regarded as "storybook core packages".
  3. It combines (and de-duplicate) both lists into 1 array
  4. It fetches the packageManager.latestVersion for each entry
  5. Now it checks if the package is upgradable
  6. If there are package upgradable then we prompt to user
  7. If the user answers yet, we continue
  8. It will modify the package.json file and then run packageManager.installDependencies
  9. It will run a dedupe command
  10. And finally it will print a tiny report. (some of the report is going to be duplicated by the doctor, but it felt useful still.

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

I tested this by running it manually:

yarn sb automigrate upgradeStorybookRelatedDependencies

It's hard to simulate the code that triggers detecting if the user is updating to latest.

Here's what it looks like if it detects some packages being outdated:
Screenshot 2024-03-07 at 18 15 09

And here's the full output, with the mini report and then the doctor output as well:
Screenshot 2024-03-07 at 18 35 27

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 Mar 7, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b74ca12. 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 changed the base branch from next to fix/doctor-compat-check March 7, 2024 17:42
Base automatically changed from fix/doctor-compat-check to next March 7, 2024 18:03
@ndelangen ndelangen requested a review from shilman March 8, 2024 11:18
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Excellent! Left some comments. Also a test for the new automigration would be nice ❤️

@ndelangen ndelangen merged commit 0cfd141 into next Mar 8, 2024
54 of 55 checks passed
@ndelangen ndelangen deleted the norbert/automigration-upgrading-storybook-related-deps branch March 8, 2024 19:50
@github-actions github-actions bot mentioned this pull request Mar 8, 2024
22 tasks
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]: sb upgrade (prerelease) does not upgrade satellite packages
3 participants