bazel: fix git SHA embedding #841
Conversation
Previously, the SHA generation genrule used a glob over .git/** to figure out if anything changed. This does not work when envoy is embedded in another git repo as a submodule, or is potentially built from a tarball. This commit reworks the generation to expect an env var called GIT_BUILD_SHA which will be used as the final SHA in the build. CI has been updated to use the GIT SHA being built from. If the env var is not defined, the SHA is set to a default SHA. This commit also removes a dependency on version_lib from test main, which was causing all tests to be relinked for no reason.
|
@htuch I will add some docs tomorrow, but I wanted to get a pass on this. I'm not thrilled with this, but AFAICT it's the only way of doing this, since I don't think a genrule can be forced to run when an env var changes like a repository_rule can. Also, it spits out this warning when I run the build: If we care about this, I have no idea how to fix it. Anyway, I think this solution should work for your internal build also. LMK if there is a way to make this better. |
| EOF | ||
|
|
||
| cat <<EOF > BUILD | ||
| exports_files(["version_generated.cc"]) |
There was a problem hiding this comment.
If you create a cc_library here instead of using exports_files, you will be able to avoid the warning, referring to it as @git_version//:version_generated instead.
| @@ -5,3 +5,6 @@ load("//bazel:cc_configure.bzl", "cc_configure") | |||
|
|
|||
| envoy_dependencies() | |||
| cc_configure() | |||
|
|
|||
| load("//bazel:git_version.bzl", "git_version") | |||
There was a problem hiding this comment.
NIt: nominal Bazel style is to have all load at top of file (https://bazel.build/versions/master/docs/skylark/build-style.html), but it's not a big issue in a short WORKSPACE file to me, just a FYI.
|
|
||
| git_version_rule = repository_rule( | ||
| implementation = _impl, | ||
| environ = ["GIT_BUILD_SHA"] |
There was a problem hiding this comment.
Nit: add , at EOL to match BUILD style
| git_version_rule = repository_rule( | ||
| implementation = _impl, | ||
| environ = ["GIT_BUILD_SHA"] | ||
| ) |
| @@ -8,6 +8,6 @@ envoy_package() | |||
|
|
|||
| envoy_cc_library( | |||
| name = "version_generated", | |||
| srcs = ["//:version_generated.cc"], | |||
| srcs = ["@git_version//:version_generated.cc"], | |||
There was a problem hiding this comment.
We should basically nuke this file once we have the cc_library change below, since it won't do anything. Then, anyone who wants //source/version_generated as a dep should get an external_dep to version_generated. We should bind version_generated to @git_version//:version_generated in the def git_version(): to make that work. Then.. we can easily handle this during our import :)
|
Adding a reference to bazelbuild/bazel#216 and #415 for posterity. |
|
Closing in favor of a different solution. |
This is an alternative to envoyproxy#841, using the technique described in https://groups.google.com/forum/m/#!topic/bazel-discuss/9kqLmOq_m_U. See also bazelbuild/bazel#2893.
This is an alternative to #841, using the technique described in https://groups.google.com/forum/m/#!topic/bazel-discuss/9kqLmOq_m_U. See also bazelbuild/bazel#2893.
Description: actions infra is failing to start android 28. However, android 29 works fine. This PR updates CI to start the android emulator with android 29. Risk Level: low Testing: local and CI Docs Changes: updated the docs to SDK version 29 for requirements Fixes #841 Signed-off-by: Jose Nino <[email protected]> Signed-off-by: JP Simard <[email protected]>
Description: actions infra is failing to start android 28. However, android 29 works fine. This PR updates CI to start the android emulator with android 29. Risk Level: low Testing: local and CI Docs Changes: updated the docs to SDK version 29 for requirements Fixes #841 Signed-off-by: Jose Nino <[email protected]> Signed-off-by: JP Simard <[email protected]>
Previously, the SHA generation genrule used a glob over .git/**
to figure out if anything changed. This does not work when envoy is
embedded in another git repo as a submodule, or is potentially built
from a tarball. This commit reworks the generation to expect an env
var called GIT_BUILD_SHA which will be used as the final SHA in the
build. CI has been updated to use the GIT SHA being built from.
If the env var is not defined, the SHA is set to a default SHA.
This commit also removes a dependency on version_lib from test main,
which was causing all tests to be relinked for no reason.