[Support Guide] Debugging Netlify site builds

Note: This article is only about builds within Netlify’s Continuous Integration (CI) environment, as triggered from git commits or from incoming build webhooks. You can learn more in depth about how Netlify builds your site in this article about how our build bots build sites.

Some background

There are a fair number of reasons that a build could fail in Netlify’s CI environment, even if building works locally. Testing locally is always the place to start, and the thing we will recommend to you first when asking for help. Further, you should make sure your build works locally from a fresh clone of the respective branch of your repository. An existing local copy of your code can have local changes that are not reproduced by a git clone, which is how our build network fetches your code, before starting your build.

Note also that there is no “cache” of your build - we cache only your dependencies, NOT the actual files from the last build - those are on our CDN but not available directly during build. The intended use pattern is: “check all the files you need to regenerate your site into git, and let us regenerate the site completely each build from that source code”. It’s an antipattern to commit your node_modules folder or pre-built files already in your publish directory, unless you are NOT having us build your site.

Debugging

The most likely reason for a build failure on Netlify happens when our build environment isn’t configured to match your local environment. There are other reasons as well, which you can read more about here, in our article on troubleshooting build problems, but the version mismatch is the probable reason for problems. This article describes all the possible build settings and versions and how to set them, so it is a great place to start when reviewing our configuration versus your local configuration. Read on for more detailed advice on what to try for your build to get it working!

Since most of our builds use Node.js/Javascript, you should make sure that we build using the same versions of Node.js, npm, and the same Node environment settings that you do locally. Take a look at this article, which has instructions on how to check which versions of Node.js and npm you have installed on your local machine.

Our current default versions as of July 2020 (though subject to upgrade at any time) are:

  • a NODE_ENV setting of development
  • Node v12.18.0
  • NPM v6.14.4 (default with that version of Node)
  • Yarn v1.22.4 (note that we only install Yarn automatically if you have a yarn.lock file. If you mean to use Yarn but don’t have a yarn.lock in your repository, add Yarn to your package.json so we install it for you before you try to use it :slight_smile: )

You can adjust those versions as follows:

  • Set the Node.js environment with the NODE_ENV variable
  • Set a NODE_VERSION environment variable from the “Build and Deploy” site settings page in our UI - in the “Build Environment” section. The value inside can be anything you would use with nvm (eg 8 or 10.11.2). You can also use a .nvmrc file with this number in it.
  • Set the npm version by setting an NPM_VERSION variable
  • Set a Yarn version with the YARN_VERSION variable

If your build is hanging or terminating abruptly, you could be using too much memory or trying to deploy so many new files we can’t complete the deploy in the default time limits. This post has some more information on those limits and how to troubleshoot.

What next?

In case that doesn’t help you fix your build, the easiest way to debug your build in our environment is to pull down the Docker container that we use as a build image and use it interactively. You must first install Docker (it’s free!) from this website or use your preferred package manager. Then, using a fresh clone of your repo, follow the steps outlined in this doc to use our build container locally: https://github.com/netlify/build-image#running-locally

In case that still doesn’t help, don’t give up! Please start a new thread, link to this one, and tell us the information you gathered while debugging:

  • a link to your most recent deployment attempt in our UI (should start with https://app.netlify.com/sites/…). This will only help the community debug in case your build logs are public, of course. Most public repositories are set with public build logs, and our Support team can by request make your own site’s build logs public even if it’s a private repository.
  • include the specific log line you think the error is in, from that latest deploy you tried to debug and have linked. Make sure you find the root cause error line - Build script exited with Error 1 is a SYMPTOM of some prior error from your build script :slight_smile:
  • give a short, succinct rundown on what you have tried so far and we’ll try to help.
1 Like
Error running command: Build script returned non-zero exit code: 1
Error running command: Build script returned non-zero exit code: 127
Gatsby builds only failing on Netlify
Build fails on push but not when locally built and deployed using Netlify CLI
[Support Guide] Frequently encountered problems during builds
Failed Building production JavaScript and CSS bundles - Build script returned non-zero exit code: 1
Deploy error Unable to find theme Directory
Vuetify Button Fab not appearing the same on netlify as on my local environment
Deploy is hanging - PostCSS problem
Only some posts are visible when deploying with Jekyll/Github
[Support Guide] My site deploy fails unless Netlify's build cache is cleared
Support Guides - Or, how to find answers for frequent questions!
[Support Guide] How can I optimize my Netlify build time?
[Support Guide] How do I access private repositories in the build environment?
Nuxt is compiling Firebase Functions
Gatsby deployment problem
Updating node modules
All builds fail after 30 seconds, even previously successful ones
Tried deploying my first project, but no luck
Help with deploying on netlify
GraphQL...unix error: No such file or directory
Not able to see changes to the deployed site
Deploying a phoenix app on netlify
Error during build Angular App
Unable to build due to waiting for capacity
Deployment and Netlify Build Image Errors
Netlify deployment fails with message: failed during stage 'building site': Build script returned non-zero exit code: 127
Cannot deploy react app, deploy fails
Production build fails due to eslint `console.log()` errors, possible issue with NODE_ENV
Deployment Error
Cant deploy Create React App site
I'm having trouble getting my website to load
Problems with deploy of my website, from today
How does one debug a netlify build issue?
My hugo site lost some elements after deploy?
Help with site deployment
Can't edit the value of a DNS record of a domain managed by Netlify DNS
Can you help me to debug this?
Need advice to troubleshoot this deployment
Jekyll build works locally but fails to build on netlify due to import error
Need help with fail stage building site
Deploy Error - failed to fetch cache
Build script Build script returned non-zero exit code: 3
React Static build with hundreds of pages fails silently
Netlify deploy: Error #85907 GRAPHQL
Failing build: Failed to build site
Local NPM dependency in package.json not installing
Issue with gulp while deploying in Netlify
Replicate Netlify deployment build on local for Gatsby
Netlify Noob - Minified React error #130
Gatsby build - failed Building production JavaScript and CSS bundles
Build failing with gatsby-source-wordpress-experimental
Need help debugging "Version '12.18.0' not found - try `nvm ls-remote` to browse available versions."
Gatsby deploy rearranges my JSX
I am getting an error whenever I try automatic deployment with GitHub
CSS isn't updating after deploy
Deploys are failing all of a sudden
Hugo BUILD failing due to outdated version
Assistance with deploying a vuejs app
Error message: Gatsby-plugin-feed
Issue with Netlify Build Version
Vue site automatic compilation fails
Problem with link to page [freeze flask]
Error: [BABEL] /opt/build/repo/src/index.tsx: Cannot find module '@babel/helper-call-delegate'