CLI: Fix throwing in readonly environments #31785

JReinhold · 2025-06-16T08:33:43Z

Closes #31709

What I did

Changed the global settings logic to only log a warning if it can't save the file, instead of throwing an error
Don't run global settings logic in CI
Added a utility to more resiliently check for optional, boolean environment variables, and a shortcut isCI that uses that.

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

Improves error handling in read-only environments by replacing error throwing with warning logs and adding robust environment variable handling utilities.

Added new utilities isCI and optionalEnvToBoolean in code/core/src/common/utils/envs.ts for consistent environment detection
Modified code/core/src/telemetry/storybook-metadata.ts to skip global settings in CI environments
Updated code/lib/cli-storybook/src/bin/index.ts to use warning logs instead of throwing errors when saving fails
Fixed boolean logic in sandbox initiation to correctly disable dev mode in CI environments

greptile-apps

LGTM

_{4 files reviewed, no comments}
_{Edit PR Review Bot Settings | Greptile}

nx-cloud · 2025-06-16T08:39:51Z

View your CI Pipeline Execution ↗ for commit 0510d85

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

☁️ Nx Cloud last updated this comment at 2025-08-01 15:21:22 UTC

code/core/src/telemetry/storybook-metadata.ts

shilman

Looks good with one minor nit

storybook-app-bot · 2025-06-18T07:32:00Z

Package Benchmarks

^{Commit: 0510d85, ran on 1 August 2025 at 15:09:17 UTC}

The following packages have significant changes to their size or dependencies:

`storybook`

	Before	After	Difference
Dependency count	51	51	0
Self size	41.75 MB	41.36 MB	🎉 -384 KB 🎉
Dependency size	18.13 MB	18.13 MB	🎉 -2 B 🎉
Bundle Size Analyzer	Link	Link

`sb`

	Before	After	Difference
Dependency count	52	52	0
Self size	1 KB	1 KB	🎉 -2 B 🎉
Dependency size	59.88 MB	59.50 MB	🎉 -384 KB 🎉
Bundle Size Analyzer	Link	Link

`@storybook/cli`

	Before	After	Difference
Dependency count	220	220	0
Self size	585 KB	585 KB	🚨 +145 B 🚨
Dependency size	104.34 MB	103.96 MB	🎉 -378 KB 🎉
Bundle Size Analyzer	Link	Link

`@storybook/codemod`

	Before	After	Difference
Dependency count	189	189	0
Self size	31 KB	31 KB	🎉 -2 B 🎉
Dependency size	88.43 MB	88.05 MB	🎉 -384 KB 🎉
Bundle Size Analyzer	Link	Link

tmeasday

I have a couple questions but looks good otherwise, good improvement.

code/core/src/common/utils/envs.ts

diagramatics · 2025-07-09T04:47:54Z

👋 Just wanna bring this back since it was automatically closed. We do need this fix for our CI use case same as #31709 and it would be nice to have this also released to v8 as well since globalSettings was introduced in v8.6.14.

greptile-apps

_{19 files reviewed, 5 comments}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-07-10T18:41:15Z

code/lib/create-storybook/src/generators/baseGenerator.ts

      const { hasEslint, isStorybookPluginInstalled, isFlatConfig, eslintConfigFile } =
        // TODO: Investigate why packageManager type does not match on CI
        await extractEslintInfo(packageManager as any);


style: Type casting can hide potential issues. Consider fixing the packageManager type mismatch instead

greptile-apps · 2025-07-10T18:41:17Z

code/core/src/common/utils/envs.ts

+  if (input.toUpperCase() === 'FALSE' || input === '0') {
+    return false;
+  }


logic: Potential issue with case sensitivity - 'FALSE' check is inconsistent (uses toUpperCase) while '0' check is case-sensitive. Consider normalizing both checks.

Suggested change

if (input.toUpperCase() === 'FALSE' || input === '0') {

return false;

}

if (input.toUpperCase() === 'FALSE' || input.toUpperCase() === '0') {

return false;

}

greptile-apps · 2025-07-10T18:41:19Z

code/lib/create-storybook/src/bin/index.ts

  .action(async (options) => {
    options.debug = options.debug ?? false;
-    options.dev = options.dev ?? (IS_NON_CI && IS_NON_STORYBOOK_SANDBOX);
+    options.dev = options.dev ?? (isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX));


logic: Logic error: isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX) will enable dev mode in CI, which is opposite of the previous behavior (IS_NON_CI). Should be !isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX)

Suggested change

options.dev = options.dev ?? (isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX));

options.dev = options.dev ?? (!isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX));

greptile-apps · 2025-07-10T18:41:21Z

code/lib/cli-storybook/src/sandbox.ts

        const { initiate } = await import('create-storybook');
        await initiate({
-          dev: process.env.CI !== 'true' && process.env.IN_STORYBOOK_SANDBOX !== 'true',
+          dev: isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX),


logic: The condition needs to be inverted - currently isCI && !optionalEnvToBoolean() enables dev mode when in CI, which is opposite of the intended behavior. Should be !isCI && !optionalEnvToBoolean()

Suggested change

dev: isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX),

dev: !isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX),

greptile-apps · 2025-07-10T18:41:22Z

code/core/src/node-logger/prompts/prompt-config.ts

+let currentPromptLibrary: PromptLibrary = optionalEnvToBoolean(process.env.USE_CLACK)
+  ? 'clack'
+  : 'prompts';


style: Could the default value be extracted into a constant? This would make it easier to change the default prompt library in the future if needed.

valentinpalkovic · 2025-07-14T13:23:17Z

@JReinhold Can you take another look and maybe resolve the conflicts?

- Changed instances of `isCI` to `isCI()` in various files to ensure consistent function usage. - Updated related logic in `postinstall-logger.ts`, `postinstall.ts`, `withTelemetry.ts`, and others to reflect this change. - Enhanced test coverage for `isCI` behavior in `storybook-metadata.test.ts`.

…value provision

- Replaced direct imports of `isCI` and `logger` from internal paths with imports from centralized utility modules. - This change enhances maintainability and consistency across the codebase.

…readonly CLI: Fix throwing in readonly environments (cherry picked from commit d87db5c)

dont throw on global settings write error, dont run in CI

bf57669

JReinhold requested review from shilman and tmeasday June 16, 2025 08:33

JReinhold self-assigned this Jun 16, 2025

JReinhold added bug ci: do not merge cli telemetry ci:normal patch:yes Bugfix & documentation PR that need to be picked to main branch and removed ci: do not merge labels Jun 16, 2025

greptile-apps bot reviewed Jun 16, 2025

View reviewed changes

shilman reviewed Jun 16, 2025

View reviewed changes

code/core/src/telemetry/storybook-metadata.ts Outdated Show resolved Hide resolved

shilman approved these changes Jun 16, 2025

View reviewed changes

add more resilient utility for boolean environment variables

c458370

tmeasday approved these changes Jun 18, 2025

View reviewed changes

code/core/src/common/utils/envs.ts Show resolved Hide resolved

code/core/src/common/utils/envs.ts Outdated Show resolved Hide resolved

github-actions bot added the Stale label Jul 2, 2025

github-actions bot closed this Jul 9, 2025

valentinpalkovic reopened this Jul 10, 2025

greptile-apps bot reviewed Jul 10, 2025

View reviewed changes

github-actions bot added needs triage and removed Stale labels Jul 16, 2025

github-actions bot added the Stale label Jul 30, 2025

shilman and others added 3 commits July 31, 2025 12:16

Merge branch 'next' into jeppe/fix-global-settings-readonly

ea74f25

Merge branch 'next' into jeppe/fix-global-settings-readonly

502e7f9

yannbf removed the Stale label Jul 31, 2025

yannbf and others added 6 commits July 31, 2025 12:02

Merge branch 'next' into jeppe/fix-global-settings-readonly

8c980e7

Comment out userSince test in event-log-checker for discussion on CI …

8733611

…value provision

bundle in utilities

9e0c214

Refactor: Update imports in initiate.ts to use centralized utilities

c5354dc

- Replaced direct imports of `isCI` and `logger` from internal paths with imports from centralized utility modules. - This change enhances maintainability and consistency across the codebase.

Fix test install in agentic environments

a08989b

lazy load lazy-universal-dotenv

0510d85

yannbf merged commit d87db5c into next Aug 1, 2025
54 checks passed

yannbf deleted the jeppe/fix-global-settings-readonly branch August 1, 2025 15:24

This was referenced Aug 1, 2025

Release: Patch 9.1.1 #32175

Merged

Release: Prerelease 9.2.0-alpha.1 #32174

Merged

yannbf added a commit that referenced this pull request Aug 4, 2025

Merge pull request #31785 from storybookjs/jeppe/fix-global-settings-…

d37b759

…readonly CLI: Fix throwing in readonly environments (cherry picked from commit d87db5c)

github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Aug 4, 2025

github-actions bot mentioned this pull request Aug 13, 2025

[master] Michijs Dependabot changes michijs/michijs-storybook-template#68

Closed

ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025

	options.dev = options.dev ?? (isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX));
	options.dev = options.dev ?? (!isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX));

	dev: isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX),
	dev: !isCI && !optionalEnvToBoolean(process.env.IN_STORYBOOK_SANDBOX),

Uh oh!

CLI: Fix throwing in readonly environments #31785

CLI: Fix throwing in readonly environments #31785

Uh oh!

Conversation

JReinhold commented Jun 16, 2025 • edited by greptile-apps bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

Greptile Summary

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

nx-cloud bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

shilman left a comment

Choose a reason for hiding this comment

Uh oh!

storybook-app-bot bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Package Benchmarks

storybook

sb

@storybook/cli

@storybook/codemod

Uh oh!

tmeasday left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

diagramatics commented Jul 9, 2025

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

valentinpalkovic commented Jul 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

JReinhold commented Jun 16, 2025 •

edited by greptile-apps bot

Loading

nx-cloud bot commented Jun 16, 2025 •

edited

Loading

storybook-app-bot bot commented Jun 18, 2025 •

edited

Loading

`storybook`

`sb`

`@storybook/cli`

`@storybook/codemod`