Skip to content

Conversation

@valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Jun 16, 2025

Closes #

What I did

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!

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-storybook/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>

Greptile Summary

Updates the CLI documentation to enhance the upgrade command options, particularly expanding the functionality of the --config-dir parameter to support multiple configuration directories.

  • Changed --config-dir [dir-name] syntax to --config-dir <dir-name...> to indicate support for multiple config directories
  • Added new --write-logs option for writing debug logs to a file
  • Added new --loglevel option for controlling logging verbosity during upgrades
  • Updated option descriptions in docs/api/cli-options.mdx for better clarity

@valentinpalkovic valentinpalkovic self-assigned this Jun 16, 2025
@valentinpalkovic valentinpalkovic added documentation ci:docs Run the CI jobs for documentation checks only. labels Jun 16, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment
Edit PR Review Bot Settings | Greptile

Comment on lines +195 to +196
| `--write-logs` | Write all debug logs to a file at the end of the run.<br />`storybook upgrade --write-logs` |
| `--loglevel <level>` | Define log level: `debug`, `error`, `info`, `silent`, `trace`, or `warn` (default: `info`).<br />`storybook upgrade --loglevel debug` |
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Log level options should be consistent across commands. Some commands show 'silly' as an option while here we have 'trace'

@nx-cloud
Copy link

nx-cloud bot commented Jun 16, 2025

View your CI Pipeline Execution ↗ for commit 7532ea3.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 13s View ↗

☁️ Nx Cloud last updated this comment at 2025-06-16 06:52:23 UTC

@valentinpalkovic valentinpalkovic merged commit 0338e85 into next Jun 16, 2025
10 of 13 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/cli-docs-update branch June 16, 2025 07:43
@github-actions github-actions bot mentioned this pull request Jun 16, 2025
71 tasks
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jun 17, 2025
@github-actions github-actions bot mentioned this pull request Jun 17, 2025
15 tasks
valentinpalkovic added a commit that referenced this pull request Jun 18, 2025
Docs: Update CLI options
(cherry picked from commit 0338e85)
@github-actions github-actions bot mentioned this pull request Jun 18, 2025
15 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 18, 2025
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants