https://github.com/vercel-contrib/vercel-workaround

It should Just Work™
https://github.com/vercel-contrib/vercel-workaround

Last synced: 3 months ago
JSON representation

It should Just Work™

• Host: GitHub
• URL: https://github.com/vercel-contrib/vercel-workaround
• Owner: vercel-contrib
• Created: 2023-02-10T18:16:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-17T16:19:50.000Z (over 1 year ago)
• Last Synced: 2024-06-30T14:49:05.154Z (5 months ago)
• Language: Shell
• Homepage:
• Size: 6.84 KB
• Stars: 23
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vercel-workaround

## It should Just Work™

### Submodule

Vercel does not currently support private git submodules. The kind people are

sharing some solutions, but only options exist to check out just one submodule

in the wrong way or handle our sensitive data in a script like Tower of Babel.

This script avoids those problems in a reasonable, sounder way.

#### Build & Development Settings

> Project -> Settings -> General => Build & Development Settings

| `INSTALL COMMAND` | `bash ./vercel-submodule-workaround.sh && yarn install --immutable` |

| ----------------- | ------------------------------------------------------------------- |

#### Environment Variables

> Project -> Settings -> Environment Variables

| `GITHUB_REPO_CLONE_TOKEN` | `•••••••••••••••` |

| ------------------------- | ----------------- |

---

### Yarn Berry Offline Cache

It's not recommended to cache `node_modules`, as it can break across node

versions and won't be as fast as you would expect, especially on large projects.

To give you an idea, a `node_modules` folder of 135k uncompressed files (for a

total of 1.2GB) gives a Yarn cache of 2k binary archives (for a total of 139MB)!

#### Build & Development Settings

> Project -> Settings -> General => Build & Development Settings

| `INSTALL COMMAND` | `bash ./vercel-yarn-berry-offline-cache-workaround.sh && yarn install --immutable` |

| ----------------- | ---------------------------------------------------------------------------------- |

#### Environment Variables

> Project -> Settings -> Environment Variables

| `ENABLE_ROOT_PATH_BUILD_CACHE` | `0` |

| ------------------------------ | --- |