Skip to content

Commit deefffa

Browse files
committed
Add more info about OOM build failiure [docs]
In the section about npm run build fails in troubleshooting added more info about memory usage of the build script and a link to a tutorial for adding more swap space as a viable solution.
1 parent 629d575 commit deefffa

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

packages/react-scripts/template/README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ You can find the most recent version of this guide [here](https://github.com/fac
7979
- [Troubleshooting](#troubleshooting)
8080
- [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes)
8181
- [`npm test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra)
82-
- [`npm run build` silently fails](#npm-run-build-silently-fails)
82+
- [`npm run build` exits too early](#npm-run-build-exits-too-early)
8383
- [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku)
8484
- [Something Missing?](#something-missing)
8585

@@ -1598,9 +1598,13 @@ If this still doesn’t help, try running `launchctl unload -F ~/Library/LaunchA
15981598
15991599
There are also reports that *uninstalling* Watchman fixes the issue. So if nothing else helps, remove it from your system and try again.
16001600
1601-
### `npm run build` silently fails
1601+
### `npm run build` exits too early
16021602
1603-
It is reported that `npm run build` can fail on machines with no swap space, which is common in cloud environments. If [the symptoms are matching](https://github.com/facebookincubator/create-react-app/issues/1133#issuecomment-264612171), consider adding some swap space to the machine you’re building on, or build the project locally.
1603+
It is reported that `npm run build` can fail on machines with limited memory and no swap space, which is common in cloud environments. Even with small projects this command can increase RAM usage in your system by hundreds of megabytes, so if you have less than 1 GB of available memory your build is likely to fail with the following message:
1604+
1605+
> The build failed because the process exited too early. This probably means the system ran out of memory or someone called `kill -9` on the process.
1606+
1607+
If you are completely sure that you didn't terminate the process, consider [adding some swap space](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04) to the machine you’re building on, or build the project locally.
16041608

16051609
### `npm run build` fails on Heroku
16061610

0 commit comments

Comments
 (0)