chromaui / chromatic-cli

Chromatic CLI: `npx chromatic`
https://www.chromatic.com/docs/cli
MIT License
289 stars 72 forks source link

New exit code for timeout #864

Open akshay-xp opened 1 year ago

akshay-xp commented 1 year ago

Feature request

Introduce a new exit code specifically dedicated to timeouts.

Proposed solution

Provide users with a distinct identifier for processes that conclude due to elapsed time constraints. This enhancement streamlines error diagnostics and facilitates more precise troubleshooting in time-sensitive scenarios.

Alternative solutions

Introduce a descriptive error message signaling a build timeout, enhancing user visibility and troubleshooting capabilities when time limits are exceeded during the build process. This straightforward notification ensures users are promptly informed about the specific cause of the interruption.

Additional context When building Storybook using storybook build, the process runs smoothly without any issues. However, when using Chromatic for the build, it unexpectedly exits with code 105, causing confusion. After thorough investigation, I discovered that increasing the build timeout time using STORYBOOK_BUILD_TIMEOUT resolved the issue. FYI, my Storybook includes 1100+ stories and 400+ components.

using, Node : 18.17.1 npm: 9.6.7 Yarn: 1.22.19 @storybook/react: 7.4.5 + @storybook/react-webpack5: 7.4.5 chromatic: 9.1.0

the image below is from Gitlab CI

image

ghengeveld commented 1 year ago

Happy to accept a PR for this if you're able and willing. Otherwise this will end up on the backlog which means it may take a while for us to get to it.