Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@layerzerolabs/ignore-monorepo-buildstep

Package Overview
Dependencies
Maintainers
16
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@layerzerolabs/ignore-monorepo-buildstep

Ignore Vercel buildstep in a pnpm monorepo

  • 0.6.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
16
Created
Source

@typeofweb/ignore-monorepo-buildstep

A package that adds monorepo support for Vercel's "Ignore build-step" setting. Small, fast, with 0 external dependencies.

Why?

By default, when working in a monorepo, each push triggers Vercel to rebuild all the projects even when changes were introduced only to some of them. It takes time and blocks the build pipeline for your team. Thanks to @typeofweb/ignore-monorepo-buildstep, this is no longer a problem – Vercel becomes smarter and only rebuilds what needs building!

In a real-life project such as saleor/react-storefront, we've saved up to 85% on Vercel build times – 6.6x speedup! @typeofweb/ignore-monorepo-buildstep helps you save time and money.

Example setup

Repo structure

Assume we're using pnpm workspaces and we have the following monorepo structure:

.
├── apps
│   ├── a
│   └── b
└── packages
    ├── common
    └── depA

Apps a and b both depend on the common package. Moreover, app a depends on depA package.

Vercel config

Add the following command to the "Ignore Build Step" section in your Vercel project settings:

npx @typeofweb/ignore-monorepo-buildstep

Ignore Build Step settings in Vercel

By default, ignore-monorepo-buildstep will compare HEAD^ and HEAD. You can override this and use an env variable exposed by Vercel:

npx @typeofweb/ignore-monorepo-buildstep $VERCEL_GIT_PREVIOUS_SHA

Result

When any changes are introduced to packages/common, both apps a and b will be built:

However, when packages/depA is modified, only apps/a is built while apps/b is skipped:

Moreover, deployment statuses are reported as successful even when builds are skipped:

How does it work?

@typeofweb/ignore-monorepo-buildstep analyses the structure of the monorepo. It reads pnpm-workspace.yaml and package.json of every package, and creates a tree of dependencies inside the monorepo.

Then, it proceeds to check whether the given package or any of its dependencies were modified since the last commit with the use of git diff "HEAD^" "HEAD" --quiet.

Currently, only pnpm and yarn workspaces are supported but more is on the roadmap.

Keywords

FAQs

Package last updated on 25 Oct 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc