Skip to content

docs(build): document native prerequisites and actionable build.rs panics (USE-P1-1 / #29) - #69

Merged
CryptoJones merged 1 commit into
mainfrom
fix/build-prereqs-docs
Sep 15, 2026
Merged

CryptoJones merged 1 commit into
mainfrom
fix/build-prereqs-docs

Conversation

@CryptoJones

Copy link
Copy Markdown
Owner

Description

Resolves #29 (USE-P1-1 / Codeberg #140).

  • Added Prerequisites & Building to README.md (Rust + wasm target, capnp, protoc, Node.js, JDK 21 for engine-service) and a pointer plus the full local gate in CONTRIBUTING.md.
  • build.rs in scylla-schema, scylla-rpc, scylla-engine now panics with the missing tool and install commands for macOS, Debian/Ubuntu, Arch, and Windows.
  • Updated BACKLOG.md and ARCHITECTURE_REVIEW.md; bumped to 0.7.10 with a CHANGELOG entry.

Verification Results

  • cargo fmt --all -- --check: Passed
  • cargo clippy --workspace --all-targets -- -D warnings: Passed
  • cargo test --workspace: Passed (54 suites ok)
  • cargo audit: Passed (0 vulnerabilities, 6 allowed warnings)
  • ./scripts/check-wasm.sh: Passed
  • node crates/scylla-wasm/web/verify.mjs: Passed

🤖 Generated with Claude Code

…nics (USE-P1-1 / #29)

Add Prerequisites & Building sections to README and CONTRIBUTING, and make
the capnp/protoc build scripts panic with install commands per platform.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@CryptoJones
CryptoJones merged commit 056c141 into main Sep 15, 2026
2 of 3 checks passed
@CryptoJones
CryptoJones deleted the fix/build-prereqs-docs branch September 15, 2026 18:18
@coderabbitai

coderabbitai Bot commented Sep 15, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 3190a274-2266-4d1d-b809-f48547fab9d9

📥 Commits

Reviewing files that changed from the base of the PR and between 7d908da and 0139f77.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (9)
  • ARCHITECTURE_REVIEW.md
  • BACKLOG.md
  • CHANGELOG.md
  • CONTRIBUTING.md
  • Cargo.toml
  • README.md
  • crates/scylla-engine/build.rs
  • crates/scylla-rpc/build.rs
  • crates/scylla-schema/build.rs

Cache: Disabled due to Reviews > Disable Cache setting


📝 Summary

Summary by CodeRabbit

  • Documentation

    • Added comprehensive build prerequisites and setup instructions for macOS, Ubuntu/Debian, Arch Linux, and Windows.
    • Documented required native tools, WebAssembly verification, and workspace build and test commands.
    • Updated contributor verification requirements, including formatting, linting, security, and browser checks.
  • Usability

    • Build failures now provide actionable messages and installation guidance when required native tools are missing.
  • Release

    • Updated the project version to 0.7.10.

Walkthrough

The pull request documents native build prerequisites, adds platform-specific failure messages to three build scripts, updates verification instructions, and records the remediation in release and architecture documentation. The workspace version changes to 0.7.10.

Changes

Native prerequisite remediation

Layer / File(s) Summary
Prerequisite and verification documentation
README.md, CONTRIBUTING.md
Documents required native tools, platform-specific installation commands, workspace verification commands, audit, formatting, and lint checks.
Actionable build diagnostics
crates/scylla-schema/build.rs, crates/scylla-rpc/build.rs, crates/scylla-engine/build.rs
Replaces generic compilation failures with messages that include capnp or protoc installation guidance for macOS, Ubuntu, Arch, and Windows.
Release and remediation records
Cargo.toml, CHANGELOG.md, BACKLOG.md, ARCHITECTURE_REVIEW.md
Sets the workspace version to 0.7.10, adds release notes and comparison links, and marks USE-P1-1 as resolved. Estimated code review effort: 2 (Simple)

Change: Other · Severity of issue fixed: Medium

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/build-prereqs-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[USE-P1-1] A fresh clone fails to build on undocumented native prerequisites

1 participant