Speed up npm ci ~55% by creating separate package.json for storybook stories
#10612
Conversation
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
cdrini
added
Type: Refactor/Clean-up
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #10612 +/- ##
==========================================
- Coverage 17.27% 17.22% -0.05%
==========================================
Files 87 88 +1
Lines 4845 4859 +14
Branches 860 862 +2
==========================================
Hits 837 837
- Misses 3477 3489 +12
- Partials 531 533 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
I found storybook was taking a decent junk of time when npm installing, so split it out into a separate package.json . I set the npm commands to auto-install the new package.json though, so there should be no breaking changes in anyone's flow. The `npm run storybook` will work as before. Only potentialy breaking change is that when storybook is built, it'll build in stories/storybook-static instead of the root-level storybook-static/.
Since these dependencies are only ever used for local development, they are incredibly unlikely to need the rigor associated with package-lock.json, which is usually more important for production-facing code.
cdrini
force-pushed
the
refactor/storybook-package-json
branch
from
43dfb8b to
814ed0e
Compare
cdrini
changed the title
npm ci 48% by creating separate package.json for storybook storiesnpm ci ~55% by creating separate package.json for storybook stories
github-actions
bot
added
the
Needs: Response
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Refactor. I found
npm cihas been super slow to get through, and often hanging when running in our testing deploys. I tried removing tesseract/some other dependencies, but it seemed to make little difference. It turned out that storybook was taking a decent chunk of time when npm installing, so tried splitting it out into a separate package.json , andnpm cibecame quite a bit faster! I set the npm commands to auto-install the new package.json though, so there should be no breaking changes in anyone's flow. Thenpm run storybookcommand will work as before.Only potentially breaking change is that when storybook is built, it'll build in stories/storybook-static instead of the root-level storybook-static/.
Technical
Some metrics of fresh installs:
Before, with storybook:
time npm ci --no-audittook 7m12s, 6m12, avg 6m42node_modulesis 474 MBnpm list | wc -lis 58After, without storybook:
time npm ci --no-audittook 3m45s, 2m21, avg 3m03 (55% reduced)node_modulesis 300 MB (36% reduced)npm list | wc -lis 53Testing
Screenshot
Up and running!
Stakeholders
@jimchamp