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: Improve dependency metadata detection in storybook doctor #25037

Merged
merged 2 commits into from
Nov 29, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Nov 29, 2023

Closes N/A

What I did

There was an issue in the CLI doctor command where it would not detect the storybook package on certain package managers because they would output things like └─ storybook@npm:7.4.0 and it would result in └─ storybook as a name. This PR fixes that and adds a couple more fixes along the way

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!

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Make it wrong e.g. change storybook dependency to 7.3.0 and leave the rest as 7.6.0
  3. run /path/to/cli/bin/index.js doctor and see it do the right work:

image

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>

@yannbf yannbf added bug cli patch:yes Bugfix & documentation PR that need to be picked to main branch labels Nov 29, 2023
@yannbf yannbf merged commit 7b2d407 into next Nov 29, 2023
59 of 60 checks passed
@yannbf yannbf deleted the yann/improve-doctor-cli branch November 29, 2023 15:22
yannbf added a commit that referenced this pull request Nov 29, 2023
CLI: Improve dependency metadata detection in storybook doctor
(cherry picked from commit 7b2d407)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Nov 30, 2023
@github-actions github-actions bot mentioned this pull request Dec 7, 2023
44 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal cli 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants