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: Versioned upgrade of monorepo packages #25553

Merged
merged 11 commits into from
Jan 12, 2024
Merged

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Jan 10, 2024

What I did

This PR changes the upgrade command from always upgrading to latest or next versions, to upgrading to the version that the CLI is started as. This adds support for the scenario where users want to upgrade to a specific version that might not be the latest, by doing eg. npx [email protected] upgrade.

It also throws errors if users attempt to "upgrade" to a lower or equal version than the one already installed. A warning is also shown if users are upgrading to a non-latest version. This is a common mistake when running npx storybook upgrade without the version specifier, but it is a valid use-case, hence the warning.

Another major change here is that previously we would upgrade (almost) all packages containing "storybook" in their name, while now we only upgrade the packages in this monorepo, because they are the only ones we truly know how to upgrade.

cc @mandarini

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

  1. Open/init a project with an older version of Storybook. You can mimic this by just changing the versions in package.json to something like 7.5.0
  2. Upgrade it with npx storybook@next upgrade and see that it upgrades to the newest prerelease
  3. Try to upgrade it again, you should get the "equal versions" error.
  4. Try to "upgrade" backwards with npx storybook@latest upgrade, you should get the "lower versions" error

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>

@@ -134,6 +134,8 @@ export abstract class JsPackageManager {

done = commandLog('Installing dependencies');

logger.log();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this adds a newline so that the package manager's install logs are not written to the same line

Copy link
Contributor

@mandarini mandarini left a comment

Choose a reason for hiding this comment

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

The nx-related changes look good to me. I can confirm that filtering the dependencies to packages that exist in this file (https://github.com/storybookjs/storybook/blob/next/code/lib/cli/src/versions.ts) will indeed not upgrade @nx/storybook.

Thanks!

@JReinhold JReinhold added the maintenance User-facing maintenance tasks label Jan 11, 2024
@ndelangen ndelangen merged commit 47cfe3a into next Jan 12, 2024
58 checks passed
@ndelangen ndelangen deleted the cli-versioned-upgrade branch January 12, 2024 11:29
@github-actions github-actions bot mentioned this pull request Jan 12, 2024
27 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal cli maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants