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.

Sign up for GitHub

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

Jump to bottom

CLI: Improve steps in storybook init #22502

Merged
merged 2 commits into from
Jun 13, 2023
Merged

CLI: Improve steps in storybook init #22502

merged 2 commits into from
Jun 13, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented May 10, 2023

What I did

Switched the order of actions to:

  1. install dependencies
  2. on success, write storybook config files

Before, if installing deps failed, users would end up with Storybook files, but no dependencies or package scripts. It's better to fail early and only proceed with config files when deps are installed correctly

How to test

  1. Build the CLI
  2. Get a project without Storybook, make it contain an invalid entry on package.json
  3. Run init, it should fail
  4. It should not contain Storybook files

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@yannbf
switch order of actions in baseGenerator
2783ab3 
1. install dependencies
2. on success, write storybook config files
@yannbf yannbf added bug cli patch:yes Bugfix & documentation PR that need to be picked to main branch labels May 10, 2023
shilman
shilman approved these changes Jun 13, 2023
View reviewed changes
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.

LGTM!

@yannbf yannbf changed the title CLI: improve steps in storybook init CLI: Improve steps in storybook init Jun 13, 2023
@yannbf yannbf merged commit b50aa50 into next Jun 13, 2023
@yannbf yannbf deleted the feat/generate-files-later-in-init branch June 13, 2023 07:40
@github-actions github-actions bot mentioned this pull request Jun 13, 2023
Merged
42 tasks
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
94f5b17 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
be81f5d 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
ec2d3b2 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
@github-actions github-actions bot mentioned this pull request Jun 13, 2023
Merged
69 tasks
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
0098045 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
dc2a8d0 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
a9559e5 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
48adaf9 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
38d8ce3 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
aa41f18 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
11b7885 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
f6bf023 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
b08b2bc 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
9f99bef 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
12f8657 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
101f3af 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
d9195f6 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
github-actions bot pushed a commit that referenced this pull request Jun 14, 2023
@yannbf @github-actions
Merge pull request #22502 from storybookjs/feat/generate-files-later-…
0b3a6c9 
…in-init

CLI: Improve steps in storybook init
(cherry picked from commit b50aa50)
@JReinhold JReinhold added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 15, 2023
@dannyhw dannyhw mentioned this pull request Feb 5, 2024
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shilman shilman shilman approved these changes

@valentinpalkovic valentinpalkovic Awaiting requested review from valentinpalkovic

Assignees

@yannbf yannbf

Labels
bug 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@yannbf @shilman @JReinhold