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 fix version detection of upgrading related packages #26410

Merged
merged 1 commit into from
Mar 11, 2024

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Mar 11, 2024

What I did

  • add a flag for detecting is the latest version we got from npm matches the version of the CLI exactly

The flag outdated checks over preleases as well, assuming a prerelease being available means it's outdated.

For this feature , we want to know if the version on NPM is the exact same as the current CLI version.

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 have a reproduction on rc.2, and I ran:

node /{path-to}/storybook/code/lib/cli/bin/index.js upgrade

This produced the correct result:
The automigration was NOT added.

Testing the inverse is a lot harder..
But I managed to simulate it roughly..

I changed this line:

const isExactLatest = currentVersion === latestVersion;

to:

const isExactLatest = true; //currentVersion === latestVersion;

I reset the repro to before the upgrade & ran the command again:

node /{path-to}/storybook/code/lib/cli/bin/index.js upgrade

This time the automigration was correctly added!

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

☁️ Nx Cloud Report

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

Sent with 💌 from NxCloud.

@ndelangen ndelangen marked this pull request as ready for review March 11, 2024 13:20
@ndelangen ndelangen merged commit eac3a3b into next Mar 11, 2024
66 of 72 checks passed
@ndelangen ndelangen deleted the norbert/fix-automigration-latest-detection branch March 11, 2024 13:41
@github-actions github-actions bot mentioned this pull request Mar 11, 2024
3 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.

2 participants