-
Notifications
You must be signed in to change notification settings - Fork 664
docs(dev): add Troubleshooting to DEVELOPMENT.md #9812
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
881e5b1
434a9e3
516634c
a90ada0
6b59b47
3b02b06
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,6 +16,7 @@ you right. Let's get started. | |
- [Debugging](#debugging) | ||
- [Logs](#logs) | ||
- [Tokio](#tokio) | ||
- [Troubleshooting](#troubleshooting) | ||
- [Building](#building) | ||
- [Building on Windows](#building-on-windows) | ||
- [File permissions](#file-permissions) | ||
|
@@ -222,6 +223,116 @@ We are also collecting tokio's runtime tracing information that could be viewed | |
|
||
--- | ||
|
||
## Troubleshooting | ||
|
||
Common issues and solutions when developing GitButler. | ||
|
||
### Turbo/Build Issues | ||
|
||
### Case-sensitive volume problems | ||
|
||
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. | ||
|
||
**Solution:** See the related issue at [vercel/turborepo#8491](https://github.com/vercel/turborepo/issues/8491) for current workarounds. | ||
|
||
#### Turbo daemon issues | ||
|
||
If builds are hanging or behaving unexpectedly: | ||
|
||
```bash | ||
# Stop the turbo daemon | ||
$ pnpm exec turbo daemon stop | ||
|
||
# Clear turbo cache | ||
$ pnpm exec turbo daemon clean | ||
|
||
# Restart development | ||
$ pnpm dev:desktop | ||
``` | ||
|
||
### Cache Issues | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you lower-case There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done — normalized “issues” to lower-case across all headings. |
||
|
||
If you're seeing stale builds or unexpected behavior: | ||
|
||
```bash | ||
# Clear all caches | ||
$ pnpm clean | ||
$ cargo clean | ||
$ rm -rf node_modules | ||
$ pnpm install | ||
``` | ||
|
||
### Platform-specific Issues | ||
|
||
For Windows-specific build issues, refer to the [Building on Windows](#building-on-windows) section. Common issues include: | ||
|
||
- Missing Perl interpreter for OpenSSL compilation | ||
- Incorrect npm prefix configuration | ||
- File permission issues with pnpm | ||
|
||
#### macOS | ||
|
||
- Ensure Xcode Command Line Tools are installed: `xcode-select --install` | ||
- If using Homebrew, ensure cmake is installed: `brew install cmake` | ||
|
||
#### Linux | ||
|
||
- Double-check all system dependencies are installed (see Prerequisites) | ||
- On some distributions, you may need additional development packages | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I find this too vague to the point where it can be removed. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed the generic Linux |
||
|
||
### Node.js and pnpm Issues | ||
|
||
#### pnpm installation failures | ||
|
||
```bash | ||
# Disable and re-enable corepack | ||
$ corepack disable | ||
$ corepack enable | ||
|
||
# Or install pnpm globally | ||
$ npm install -g pnpm | ||
``` | ||
|
||
#### Node version conflicts | ||
|
||
Use the Node version pinned by `.nvmrc` (currently LTS “jod” / Node 22): | ||
|
||
```bash | ||
nvm install | ||
nvm use | ||
node -v | ||
``` | ||
|
||
### Rust Issues | ||
|
||
#### Cargo build failures | ||
|
||
```bash | ||
# Update Rust toolchain | ||
$ rustup update | ||
|
||
# Clean and rebuild | ||
$ cargo clean | ||
$ cargo build | ||
``` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed the generic Rust section. |
||
|
||
#### Missing system dependencies | ||
|
||
On Linux, if you're getting linking errors, ensure all required system libraries are installed. Revisit the Prerequisites section for your distribution. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Again, I think this is too general and should be removed. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
||
|
||
### Additional Resources | ||
|
||
For issues specific to our toolchain components: | ||
|
||
- [Turborepo Issues](https://github.com/vercel/turborepo/issues) | ||
- [Tauri Issues](https://github.com/tauri-apps/tauri/issues) | ||
- [Svelte Issues](https://github.com/sveltejs/svelte/issues) | ||
- [Rust Issues](https://github.com/rust-lang/rust/issues) | ||
|
||
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. | ||
|
||
--- | ||
|
||
## Building | ||
|
||
To build the app in production mode, run: | ||
|
Uh oh!
There was an error while loading. Please reload this page.