Rework lighthouse_version to reduce spurious recompilation
#8336
+110
−101
Conversation
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
macladson
added
code-quality
devex
ready-for-review
macladson
commented
Oct 31, 2025
Comment on lines
-13
to
+16
| args = [ | ||
| "--always", | ||
| "--dirty=+", | ||
| "--abbrev=7", | ||
| // NOTE: using --match instead of --exclude for compatibility with old Git | ||
| "--match=thiswillnevermatchlol" | ||
| ], | ||
| prefix = "Lighthouse/v8.0.0-rc.2-", | ||
| fallback = "Lighthouse/v8.0.0-rc.2" | ||
| ); | ||
| /// `Lighthouse/v8.0.0-67da032` | ||
| pub const VERSION: &str = env!("GIT_VERSION"); | ||
|
|
||
| /// Returns the first eight characters of the latest commit hash for this build. | ||
| /// | ||
| /// No indication is given if the tree is dirty. This is part of the standard | ||
| /// for reporting the client version to the execution engine. | ||
| pub const COMMIT_PREFIX: &str = git_version!( | ||
| args = [ | ||
| "--always", | ||
| "--abbrev=8", | ||
| // NOTE: using --match instead of --exclude for compatibility with old Git | ||
| "--match=thiswillnevermatchlol" | ||
| ], | ||
| prefix = "", | ||
| suffix = "", | ||
| cargo_prefix = "", | ||
| cargo_suffix = "", | ||
| fallback = "00000000" | ||
| ); | ||
| pub const COMMIT_PREFIX: &str = env!("GIT_COMMIT_PREFIX"); |
There was a problem hiding this comment.
We could also consider moving to an 8 character commit hash. Currently we provide both a 7 character hash (for --version, etc) and an 8 character hash (for execution engine reporting). If we can use 8 character hashes for everything, that would reduce some complexity
macladson
commented
Oct 31, 2025
Comment on lines
-26
to
-31
| update_cargo_toml ../account_manager/Cargo.toml | ||
| update_cargo_toml ../beacon_node/Cargo.toml | ||
| update_cargo_toml ../boot_node/Cargo.toml | ||
| update_cargo_toml ../lcli/Cargo.toml | ||
| update_cargo_toml ../lighthouse/Cargo.toml | ||
| update_cargo_toml ../validator_client/Cargo.toml |
There was a problem hiding this comment.
I'm using workspace version inheritance for the binaries that were explicitly listed here, but we could also include the other ones (database_manager, validator_manager, slasher) to keep it consistent
pawanjay176
approved these changes
Oct 31, 2025
michaelsproul
approved these changes
Nov 3, 2025
michaelsproul
added
ready-for-merge
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Issue Addressed
#8311
Proposed Changes
Removes the
git_versioncrate fromlighthouse_versionand implements gitHEADtracking manually.This removes the (mostly) broken dirty tracking but prevents spurious recompilation of the
lighthouse_versioncrate.This also reworks the way crate versions are handled by utilizing workspace version inheritance and Cargo environment variables.
This means the only place where Lighthouse's version is defined is in the top level
Cargo.tomlfor the workspace. All relevant binaries then inherit this version. This largely makes thechange_version.shscript useless so I've removed it, although we could keep a version which just alters the workspace version (if we need to maintain compatibility with certain build/release tooling.When is a Rebuild Triggered?
Note that working/staged changes will not trigger a recompile of
lighthouse_version.Additional Info
There might exist certain edge cases with packed git refs where a recompile might not get triggered after a git garbage collection cycle but I suspect this will be quite rare.