You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add troubleshooting section to DEVELOPMENT.md
- Add comprehensive troubleshooting section between Debugging and Building
- Include solutions for case-sensitive volume issues with Turbo
- Add Turbo daemon fixes and cache clearing procedures
- Cover platform-specific issues and Node.js/pnpm problems
- Provide links to toolchain-specific GitHub issues
- Update Table of Contents with new section
Addresses #5025
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+110Lines changed: 110 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ you right. Let's get started.
16
16
-[Debugging](#debugging)
17
17
-[Logs](#logs)
18
18
-[Tokio](#tokio)
19
+
-[Troubleshooting](#troubleshooting)
19
20
-[Building](#building)
20
21
-[Building on Windows](#building-on-windows)
21
22
-[File permissions](#file-permissions)
@@ -222,6 +223,115 @@ We are also collecting tokio's runtime tracing information that could be viewed
222
223
223
224
---
224
225
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
+
# Clear all caches
259
+
$ pnpm clean
260
+
$ cargo clean
261
+
$ rm -rf node_modules
262
+
$ pnpm install
263
+
```
264
+
265
+
### Platform-specific Issues
266
+
267
+
For Windows-specific build issues, refer to the [Building on Windows](#building-on-windows) section. Common issues include:
268
+
269
+
- Missing Perl interpreter for OpenSSL compilation
270
+
- Incorrect npm prefix configuration
271
+
- File permission issues with pnpm
272
+
273
+
#### macOS
274
+
275
+
- Ensure Xcode Command Line Tools are installed: `xcode-select --install`
276
+
- If using Homebrew, ensure cmake is installed: `brew install cmake`
277
+
278
+
#### Linux
279
+
280
+
- Double-check all system dependencies are installed (see Prerequisites)
281
+
- On some distributions, you may need additional development packages
282
+
283
+
### Node.js and pnpm Issues
284
+
285
+
#### pnpm installation failures
286
+
287
+
```bash
288
+
# Disable and re-enable corepack
289
+
$ corepack disable
290
+
$ corepack enable
291
+
292
+
# Or install pnpm globally
293
+
$ npm install -g pnpm
294
+
```
295
+
296
+
#### Node version conflicts
297
+
298
+
Ensure you're using Node 20+. If using a version manager like nvm:
299
+
300
+
```bash
301
+
$ nvm use 20
302
+
$ nvm alias default 20
303
+
```
304
+
305
+
### Rust Issues
306
+
307
+
#### Cargo build failures
308
+
309
+
```bash
310
+
# Update Rust toolchain
311
+
$ rustup update
312
+
313
+
# Clean and rebuild
314
+
$ cargo clean
315
+
$ cargo build
316
+
```
317
+
318
+
#### Missing system dependencies
319
+
320
+
On Linux, if you're getting linking errors, ensure all required system libraries are installed. Revisit the Prerequisites section for your distribution.
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.
0 commit comments