Make a fresh clone buildable: working setup script and real install docs#18
Merged
Conversation
Previously scripts/download-liblbug.sh ran with its default target (repo lib/), which neither build.rs, .cargo/config.toml, nor the macOS staging script read, and the sigma.js fork referenced by package.json (file:.deps/sigma.js/packages/sigma) was only provisioned in CI. scripts/setup.sh now clones and builds the sigma fork (same repo/ref as .github/workflows/build.yml), downloads prebuilt liblbug into src-tauri/liblbug at the exact version pinned by the lbug crate in src-tauri/Cargo.toml (re-downloading when the pin changes), downloads icebug, and stages macOS frameworks. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The previous instructions (npm install, cargo tauri dev) omitted every non-obvious prerequisite: the Tauri CLI cargo plugin, the Tauri system libraries, the vendored sigma.js fork, the prebuilt liblbug/icebug libraries, and Apache Arrow C++ / OpenMP for the icebug-analytics feature. They also required a "ladybugdb backend API at :3001" that nothing in the code references. Replace them with a platform-agnostic build overview, a Debian 13 walkthrough verified end to end on trixie, and a troubleshooting section for the failure modes met along the way. Notably, the Arrow C++ major version must match the one the icebug prebuilt was linked against (currently 24), so the walkthrough pins and holds libarrow-dev. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Package names match Debian's and the Apache Arrow repository serves ubuntu/resolute with libarrow-dev, so the Debian 13 steps should apply verbatim. Not verified end to end. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Situational: only hits Debian 13 systems that have pulled the curl stack from trixie-backports (libcurl3t64-gnutls 8.20 and friends). libarrow-dev needs the stable libcurl4-openssl-dev chain, whose libnghttp3-dev conflicts with the backports libnghttp3-9; apt cannot resolve it unless the whole cluster is downgraded in one transaction. The pinned version strings will age with trixie point releases. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
0.18.1 fixes SSL CA certificate detection for extension downloads (LadybugDB/ladybug#640). Caveat: SSL on macOS is not fully settled in this release; the published 0.18.1 macOS Node addon still hardcodes build-machine OpenSSL paths, addressed post-release by LadybugDB/ladybug#682. That addon is a different artifact from the liblbug C library linked here, so it does not gate this bump. Point CI's liblbug artifact resolution at the matching ref; CI needs a successful build-and-deploy run for v0.18.1 to exist. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WARNING: This is an entirely vibe-coded contribution, by Fable. My goal is to save somebody else the time or the tokens, or both. I am happy to post this as a gist, if preferred.
I could not build a fresh clone from the README:
npm run setupdownloaded liblbug tolib/, which is not picked upWhat this PR brings to fix that:
scripts/setup.sh(new target ofnpm run setup): clones and builds the sigma.js fork (same repo/ref as CI), downloads prebuilt liblbug intosrc-tauri/liblbugat the version pinned insrc-tauri/Cargo.toml, downloads icebug, stages macOS frameworks.Tested:
on Debian 13 from clean prerequisites through
cargo tauri dev --features=icebug-analyticsrendering a real database. macOS/Windows untested;setup.shreproduces CI's exact steps for them.