How to Resolve Java OutOfMemoryError When Running Gradlew AssembleRelease for React Native Projects?

What causes the OutOfMemoryError during Gradlew assembleRelease in React Native projects and how can I solve it?

android:largeHeap="true" in AndroidManifest.xml
dexOptions {
    javaMaxHeapSize "4g"
}
org.gradle.jvmargs=-Xmx4096m -XX:MaxPermSize=4096m -XX:+HeapDumpOnOutOfMemoryError
org.gradle.daemon=true
org.gradle.parallel=true
org.gradle.configureondemand=true

The OutOfMemoryError during Gradlew assembleRelease is a common issue that arises due to insufficient heap space when building large React Native applications. This error can halt your build process, but there are effective strategies to resolve it.

android {
    dexOptions {
        javaMaxHeapSize "4g"
    }
}

android:largeHeap="true" in AndroidManifest.xml

org.gradle.jvmargs=-Xmx4096m -XX:MaxPermSize=4096m -XX:+HeapDumpOnOutOfMemoryError in gradle.properties

Causes

• Large project size exceeding default JVM heap memory limits.
• Inefficient code leading to increased memory usage during build.
• Unused resources or dependencies that consume memory needlessly.

Solutions

• Increase the maximum heap size in your build configuration.
• Enable large heap in your AndroidManifest.xml file.
• Optimize your project by removing unused dependencies and resources.
• Consider splitting your app into smaller modules if possible.

Mistake: Not increasing the JVM heap size adequately.

Solution: Ensure the heap size is set to a sufficient amount, such as 4GB or more if your project is large.

Mistake: Forgetting to enable the large heap option in AndroidManifest.xml.

Solution: Always include `android:largeHeap="true"` within the <application> tag.

Mistake: Neglecting to check for unused resources or libraries that may increase memory usage.

Solution: Perform a cleanup to remove any unnecessary libraries and resources from your project.