nx-ignore

nx-ignore

This package is used on platforms such as Netlify or Vercel to ignore builds if a project is not affected.

Usage

npx nx-ignore <project-name>

For Netlify, use a custom ignore command in your netlify.toml file.

For Vercel, under the Settings > Git section, use this script in Ignored Build Step field.

Options

• --base - Set a custom base SHA to compare changes (defaults to CACHED_COMMIT_REF on Netlify or VERCEL_GIT_PREVIOUS_SHA on Vercel)
• --plugins - List of Nx plugins required (i.e. plugins that extend the Nx graph). Default plugins are read from nx.json.
• --root - Set a custom workspace root (defaults to current working directory).
• --verbose - Log more details information for debugging purposes.

Skipping and forcing deployment

Skip nx-ignore check and ignore deployment:

• [skip ci]
• [ci skip]
• [no ci]
• [nx skip ]

Skip nx-ignore check and force deployment:

• [nx deploy]
• [nx deploy ]

How it works

The nx-ignore command uses Nx to determine whether the current commit affects the specified app. It exits with an error code (1) when the app is affected, which tells the platform to continue the build, otherwise it exits successfully, which tells the platform to cancel the build.