lakesoul-io/LakeSoul

Expose LakeSoul Rust build version and git commit information

Open

#790 opened on Jun 23, 2026

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Java (432 forks)batch import
good first issue

Repository metrics

Stars
 (2,236 stars)
PR merge metrics
 (Avg merge 3d 4h) (10 merged PRs in 30d)

Description

Motivation

When debugging production issues or validating compatibility, it is often useful to know exactly which LakeSoul Rust build is being used.

Currently, there is no public API to retrieve build information such as:

  • LakeSoul version
  • Git commit SHA
  • Build timestamp (optional)

This makes it difficult to identify the exact binary version when users report issues.

Proposal

Expose a public version API in the Rust implementation, for example:

pub fn version() -> &'static str;

pub struct BuildInfo {
    pub version: &'static str,
    pub git_commit: &'static str,
    pub build_time: &'static str,
}

pub fn build_info() -> BuildInfo;

Contributor guide

Research direction
Add build information retrieval using environment variables set at compile time (e.g., env!("CARGO PKG VERSION")).
Tech stack
rust
Domain
build system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80