Netlify breaks after adding netlify.toml file

Question

We are running a quite simple setup where we have a Vuepress project that is built using yarn build which relates to vuepress build. It all worked pretty great so far (first time netlify user)

We now wanted an environment variable in production builds. To do so, I added a netlify.toml that looks like the following:

[context.production]
  environment = { NODE_ENV = "production" }

I do not know why, but suddenly the build on the main branch (which is our production build) breaks because yarn cannot find the vuepress command anymore.

This worked fine before the introduction of the netlify.toml (and still works fine for non-production branches)

The build log looks like:

3:04:22 PM: $ yarn docs:build
3:04:22 PM: yarn run v1.22.10
3:04:22 PM: $ vuepress build docs --clean-cache --clean-temp
3:04:22 PM: /bin/sh: 1: vuepress: not found
3:04:22 PM: error Command failed with exit code 127.
3:04:22 PM: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

talves · Accepted Answer · 2022-01-19 19:57:29Z

1

This is a common issue on Netlify when people want to use NODE_ENV to make decisions for their builds with custom build scripts, etc.

By default the build bots on Netlify set NODE_ENV to development, so yarn will install the dev dependencies.

If vuepress is in your devDependencies, yarn will ignore them when Netlify runs the yarn install automatically. There are a couple work arounds.

use: NODE_ENV=development yarn install && yarn docs:build
use: yarn add vuepress && yarn docs:build
remove the env variable setting if you don't need it. If you need to know if it is a production build, you can always use CONTEXT which is set by Netlify on a production build.

There are some other options, but I'll leave it here for brevity.

answered Jan 19, 2022 at 19:57

talves

14.4k5 gold badges42 silver badges64 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Jelle den Burger Over a year ago

That makes a lot of sense. I couldn't find the CONTEXT variable you're referring to online. Is there some documentation around that?

talves Over a year ago

process.env.CONTEXT is here: docs.netlify.com/configure-builds/environment-variables/…

Collectives™ on Stack Overflow

Netlify breaks after adding netlify.toml file

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related