https://github.com/typeofweb-org/ignore-monorepo-buildstep

Ignore Vercel buildstep in a pnpm monorepo
https://github.com/typeofweb-org/ignore-monorepo-buildstep

hacktoberfest monorepo pnpm pnpm-workspaces turborepo vercel workspaces

Last synced: 3 months ago
JSON representation

Ignore Vercel buildstep in a pnpm monorepo

• Host: GitHub
• URL: https://github.com/typeofweb-org/ignore-monorepo-buildstep
• Owner: typeofweb-org
• License: mit
• Created: 2022-09-29T21:05:24.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-25T11:47:30.000Z (about 2 years ago)
• Last Synced: 2024-09-29T02:22:11.975Z (3 months ago)
• Topics: hacktoberfest, monorepo, pnpm, pnpm-workspaces, turborepo, vercel, workspaces
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@typeofweb/ignore-monorepo-buildstep
• Size: 207 KB
• Stars: 38
• Watchers: 0
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# @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](https://github.com/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](https://pnpm.io/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](./docs/vercel_settings.png)

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:

![](./docs/github-both.png)

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

![](./docs/github-one.png)

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

![](./docs/github-status.png)

## 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` workspaces are supported but more is on the roadmap.