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: Add --no-dev option to init #26918

Merged

Conversation

fastfrwrd
Copy link

@fastfrwrd fastfrwrd commented Apr 22, 2024

Closes #25510

What I did

adds optional --dev and --no-dev options to the storybook init CLI.

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

as far as I could tell, there aren't automated tests for the init CLI?

Manual testing

Ran the sandbox as described. Additionally, I ran the following against a fresh create-next-app to test that the flag works as expected, that the default behaviors still worked as expected, and that the intersection of the defaults and the flags also worked.

$ > npx create-next-app

$ > node ../storybook/code/lib/cli/bin/index.js init
$ > node ../storybook/code/lib/cli/bin/index.js init --dev
$ > node ../storybook/code/lib/cli/bin/index.js init --no-dev

$ > CI=true node ../storybook/code/lib/cli/bin/index.js init
$ > CI=true node ../storybook/code/lib/cli/bin/index.js init --dev
$ > CI=true node ../storybook/code/lib/cli/bin/index.js init --no-dev

$ > IN_STORYBOOK_SANDBOX=true node ../storybook/code/lib/cli/bin/index.js init
$ > IN_STORYBOOK_SANDBOX=true node ../storybook/code/lib/cli/bin/index.js init --dev
$ > IN_STORYBOOK_SANDBOX=true node ../storybook/code/lib/cli/bin/index.js init --no-dev

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>

@fastfrwrd fastfrwrd force-pushed the fastfrwrd/25510-no-dev-for-init branch from e2f661e to c3e3ab9 Compare April 22, 2024 20:41
@fastfrwrd fastfrwrd changed the title feat: #25510 add optional --no-dev option to storybook init CLI feat: #25510 add optional --dev and --no-dev options to storybook init CLI Apr 22, 2024
@valentinpalkovic valentinpalkovic self-assigned this Apr 22, 2024
@valentinpalkovic valentinpalkovic changed the title feat: #25510 add optional --dev and --no-dev options to storybook init CLI CLI: Add optional --dev and --no-dev options to storybook init CLI Apr 23, 2024
@valentinpalkovic valentinpalkovic added feature request cli ci:daily Run the CI jobs that normally run in the daily job. labels Apr 23, 2024
Copy link

nx-cloud bot commented Apr 23, 2024

☁️ Nx Cloud Report

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

Copy link
Contributor

@valentinpalkovic valentinpalkovic left a comment

Choose a reason for hiding this comment

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

LGTM!

@fastfrwrd Thank you so much for your contribution.

@valentinpalkovic valentinpalkovic merged commit e60fc12 into storybookjs:next May 14, 2024
99 of 101 checks passed
@github-actions github-actions bot mentioned this pull request May 14, 2024
17 tasks
@shilman shilman added maintenance User-facing maintenance tasks patch:yes Bugfix & documentation PR that need to be picked to main branch and removed feature request labels Jun 13, 2024
@shilman shilman changed the title CLI: Add optional --dev and --no-dev options to storybook init CLI CLI: Add --no-dev option to init Jun 13, 2024
storybook-bot pushed a commit that referenced this pull request Jun 13, 2024
CLI: Add optional `--dev` and `--no-dev` options to `storybook init` CLI
(cherry picked from commit e60fc12)
@github-actions github-actions bot mentioned this pull request Jun 13, 2024
6 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:daily Run the CI jobs that normally run in the daily job. cli maintenance User-facing maintenance tasks 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.

3 participants