Add distinct exit code for Storybook build timeouts - #1512
Open
rahul05ranjan wants to merge 1 commit into
Open
rahul05ranjan wants to merge 1 commit into
rahul05ranjan wants to merge 1 commit into
Conversation
Introduce STORYBOOK_BUILD_TIMEOUT (106) so a build that exceeds STORYBOOK_BUILD_TIMEOUT exits with a dedicated code instead of the generic NPM_BUILD_STORYBOOK_FAILED (105). runCommand() now tags its timeout error with isTimeout, and buildStorybook() maps that to the new exit code. Fixes chromaui#864
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a dedicated exit code for Storybook build timeouts, resolving #864.
Currently, when a build exceeds
STORYBOOK_BUILD_TIMEOUT, the CLI exits with the genericNPM_BUILD_STORYBOOK_FAILED(105), which is indistinguishable from an actual build failure. This makes it hard to tell "the build timed out" from "the build broke".Changes
node-src/lib/setExitCode.ts: addSTORYBOOK_BUILD_TIMEOUT: 106.node-src/lib/shell/shell.ts: tag the timeout error withisTimeout: trueso callers can distinguish it from other failures.node-src/tasks/build/buildStorybook.ts: map a timeout error toSTORYBOOK_BUILD_TIMEOUTinstead ofNPM_BUILD_STORYBOOK_FAILED.runCommandtags the error.Verification
tsc --noEmitpasses.vitest run node-src/tasks/build/buildStorybook.test.ts→ 18 passed.Note: the exit-code docs live in the separate
chromatic-docsrepo (see the comment insetExitCode.ts), so no doc change is included here.