TraceMachina/nativelink

All client side errors should have the NativeLink version attached to it

Open

#1,044 opened on Jun 22, 2024

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Rust (222 forks)auto 404
good first issue

Repository metrics

Stars
 (1,557 stars)
PR merge metrics
 (PR metrics pending)

Description

To make it easier to understand what version people are using when there's a problem, we should attach a hash that represents what version or commit of NL they are using.

cc: @aaronmondal for how we might be able to stamp this by default but not invalidate cache?

Contributor guide

Research direction
Investigate how to embed a Git commit hash into the Rust binary at compile time using build scripts or environment variables, ensuring it does not invalidate the build cache. Look into tools like `vergen` or `built` for automatic version stamping, and consider Nix's approach to reproducible builds.
Tech stack
rust
Domain
backenddevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40