[turborepo] Support Git Worktrees

[ezramorse]

What version of Turborepo are you using?

1.10.1

What package manager are you using / does the bug impact?

npm, pnpm, Yarn v1, Yarn v2/v3 (node_modules linker only)

What operating system are you using?

Mac

Describe the Bug

When using git worktree workflows, any packages built in a linked worktree will produce an initial cache miss, even if the package has previously been built & cached in the main worktree, despite the hashing being exactly the same.

Git worktrees allows multiple branches to be simultaneously checked out--and even running servers--all within the same repo, which can be critically important to an optimized CICD workflow, or even a multi-user cloud IDE environment. They do require different pathing from the main worktree, which is likely causing the cache miss.

We consider this critical functionality, because every branch created as a linked worktree cannot leverage turbo repo. The work around is creating multiple clones of a single repo for every active branch that requires work or running servers.

Expected Behavior

After packages have been successfully cached from a linked or main worktree, further package builds with matching hashes should produce hits.

To Reproduce

Create Turborepo & Link Remote Cache:

pnpm dlx create-turbo@latest
cd my-turborepo
pnpm dlx turbo login
pnpm dlx turbo link
git init

Build twice to produce a cache hit:

git checkout -b "test-branch"
pnpm dlx turbo build
pnpm dlx turbo build

Output on second build:

...
docs:build: cache hit, replaying output f74c8425215efaa1
...
web:build: cache hit, replaying output 3d87a98cc068e099
...

Checkout the current branch as a linked worktree:

git checkout main
git worktree add trees/test-branch test-branch
cd trees/test-branch

Build from the linked worktree:

pnpm install
pnpm dlx turbo build

Output:

• Packages in scope: docs, eslint-config-custom, tsconfig, ui, web
• Running build in 5 packages
• Remote caching enabled
docs:build: cache miss, executing f74c8425215efaa1
web:build: cache miss, executing 3d87a98cc068e099
...

Reproduction Repo

No response

[arlyon]

Apologies for the delayed response. I converted this to a discussion and will bring this up with the team. I think the chances of this being prioritised in the near future are low given the relative obscurity of worktrees but it is something we'd like to be aware of.

Thanks for taking the time to write this up!

[joshmedeski]

Would creating a symbolic link at .turbo across different worktrees work?