Skip to content

Commit 35152af

Browse files
authored
Merge pull request #9812 from ali90h/add-troubleshooting-section
docs(dev): add Troubleshooting to DEVELOPMENT.md
2 parents ad0021d + 3b02b06 commit 35152af

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

DEVELOPMENT.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ you right. Let's get started.
1616
- [Debugging](#debugging)
1717
- [Logs](#logs)
1818
- [Tokio](#tokio)
19+
- [Troubleshooting](#troubleshooting)
1920
- [Building](#building)
2021
- [Building on Windows](#building-on-windows)
2122
- [File permissions](#file-permissions)
@@ -222,6 +223,74 @@ We are also collecting tokio's runtime tracing information that could be viewed
222223

223224
---
224225

226+
## Troubleshooting
227+
228+
Common issues and solutions when developing GitButler.
229+
230+
### Turbo/build issues
231+
232+
#### Case-sensitive volume problems
233+
234+
If you're experiencing issues with the `dev:desktop` target failing to start, especially on macOS with case-sensitive filesystems, this may be related to Turborepo's handling of case-sensitive volumes.
235+
236+
**Solution:** See the related issue at [vercel/turborepo#8491](https://github.com/vercel/turborepo/issues/8491) for current workarounds.
237+
238+
#### Turbo daemon issues
239+
240+
If builds are hanging or behaving unexpectedly:
241+
242+
```bash
243+
# Stop the turbo daemon
244+
pnpm exec turbo daemon stop
245+
246+
# Clear turbo cache
247+
pnpm exec turbo daemon clean
248+
249+
# Restart development
250+
pnpm dev:desktop
251+
```
252+
253+
### Cache issues
254+
255+
If you're seeing stale builds or unexpected behavior:
256+
257+
```bash
258+
rm -rf .turbo node_modules
259+
pnpm install
260+
# Optional (Rust artifacts):
261+
cargo clean
262+
```
263+
264+
### Node.js & pnpm
265+
266+
Use the Node version pinned by `.nvmrc` (currently LTS “jod” / Node 22):
267+
268+
```bash
269+
nvm install
270+
nvm use
271+
node -v
272+
```
273+
274+
Use pnpm via Corepack (avoid global installs):
275+
276+
```bash
277+
corepack enable
278+
corepack pnpm -v
279+
# optionally pin a major:
280+
corepack prepare pnpm@10 --activate
281+
```
282+
283+
### Additional resources
284+
285+
For issues specific to our toolchain components:
286+
287+
- [Turborepo issues](https://github.com/vercel/turborepo/issues)
288+
- [Tauri issues](https://github.com/tauri-apps/tauri/issues)
289+
290+
If none of these solutions work, please check our [GitHub Issues](https://github.com/gitbutlerapp/gitbutler/issues) or create a new issue with detailed information about your system and the error you're encountering.
291+
292+
---
293+
225294
## Building
226295

227296
To build the app in production mode, run:

0 commit comments

Comments
 (0)