bazel: embed git version via workspace stamping#9586
Merged
maliberty merged 4 commits intoThe-OpenROAD-Project:masterfrom Mar 2, 2026
Merged
bazel: embed git version via workspace stamping#9586maliberty merged 4 commits intoThe-OpenROAD-Project:masterfrom
maliberty merged 4 commits intoThe-OpenROAD-Project:masterfrom
Conversation
Use Bazel's --workspace_status_command mechanism to populate OPENROAD_VERSION and OPENROAD_GIT_DESCRIBE in the Version.hh header. With the default --nostamp (dev builds) STABLE_GIT_VERSION is empty, so the genrule output is deterministic and the Bazel cache is never invalidated on commits. With --stamp (or --config=release) the script runs `git describe` and embeds the real version string, e.g. 26Q1-1485-g51d4ea27c3, without requiring a full rebuild. Usage: # Development build (cache-safe, version shows "bazel-nostamp"): bazel build //... # Release build (real git version embedded, e.g. "26Q1-1485-g51d4ea27c3"): bazel build --config=release //:openroad # Check the embedded version at runtime: ./bazel-bin/openroad -version Fixes The-OpenROAD-Project#7140. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a good mechanism for embedding Git version information into the build using Bazel's workspace stamping feature. The implementation is sound and addresses the goal of having cache-safe development builds while embedding real version info for release builds. I have a couple of suggestions to improve the shell scripts for better readability and maintainability.
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
1 similar comment
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
Collaborator
|
@oharboe seems to work when I tried it. Seems like the version tag gets duplicated. Otherwise it works |
- Change stamp = True to stamp = -1 so the genrule only stamps with --config=release (--stamp), not on every build. This keeps dev builds deterministic and cache-safe. - Set OPENROAD_GIT_DESCRIBE to empty string instead of duplicating OPENROAD_VERSION (which caused "26Q1-... 26Q1-..." in the banner). - Remove OPENROAD_GIT_DESCRIBE from OPENROAD_DEFINES to avoid macro redefinition with the genrule-generated Version.hh. - Document version stamping in Bazel.md and Build.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Collaborator
Author
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
1 similar comment
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
Collaborator
|
@oharboe gave it a spin, it seems to work when I try it: |
Collaborator
Author
|
I tried it with and without |
Collaborator
Author
|
@maliberty pr-merge works, pr-head fails(CI problem, I presume). manual merge? |
Collaborator
|
@oharboe it seems it's an rmp test that is failing, so unrelated to these changes, I would think a manual merge would be needed and that test reviewed (@maliberty ) log copied in here: |
gadfort
approved these changes
Mar 1, 2026
maliberty
approved these changes
Mar 2, 2026
Member
|
Question for the Bazel pros: will a .o built without stamping still generate a cache hit in a build with stamping or are they considered too different? I'm wondering if a single cache can be mostly shared between the modes (aside from the stamp itself and the final binary). |
Collaborator
Author
Claude thinks this is what is needed: |
Member
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
4 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.
Use Bazel's --workspace_status_command mechanism to populate OPENROAD_VERSION and OPENROAD_GIT_DESCRIBE in the Version.hh header.
With the default --nostamp (dev builds) STABLE_GIT_VERSION is empty, so the genrule output is deterministic and the Bazel cache is never invalidated on commits. With --stamp (or --config=release) the script runs
git describeand embeds the real version string, e.g. 26Q1-1485-g51d4ea27c3, without requiring a full rebuild.Usage:
Development build (cache-safe, version shows "bazel-nostamp"):
bazel build //...
Release build (real git version embedded, e.g. "26Q1-1485-g51d4ea27c3"):
bazel build --config=release //:openroad
Check the embedded version at runtime:
./bazel-bin/openroad -version
Fixes #7140.