bazel: Rename [API_]VERSION to [API_]VERSION.txt (envoyproxy#20219)

The C++ stdlib now has a header called `version` https://en.cppreference.com/w/cpp/header/version

On macOS, because of the case insensitive file system, if you disable
sandboxing for build performance, building C++ could pick up the root
VERSION file instead of the actual C++ version header. This renames
VERSION and API_VERSION to have the .txt extension to avoid this
conflict.

Signed-off-by: Keith Smiley <[email protected]>

Author: keith

API_VERSION API_VERSION.txt

@@ -1,8 +1,8 @@
 licenses(["notice"])  # Apache 2
 
 exports_files([
-    "VERSION",
-    "API_VERSION",
+    "VERSION.txt",
+    "API_VERSION.txt",
     ".clang-format",
     "pytest.ini",
     ".coveragerc",

BUILD

@@ -78,7 +78,7 @@ def _envoy_repo_impl(repository_ctx):
 
     """
     repo_path = repository_ctx.path(repository_ctx.attr.envoy_root).dirname
-    version = repository_ctx.read(repo_path.get_child("VERSION")).strip()
+    version = repository_ctx.read(repo_path.get_child("VERSION.txt")).strip()
     repository_ctx.file("version.bzl", "VERSION = '%s'" % version)
     repository_ctx.file("path.bzl", "PATH = '%s'" % repo_path)
     repository_ctx.file("__init__.py", "PATH = '%s'\nVERSION = '%s'" % (repo_path, version))

VERSION VERSION.txt

@@ -12,7 +12,6 @@ exports_files([
     "v2_mapping.json",
     "empty_extensions.json",
     "redirects.txt",
-    "VERSION",
 ])
 
 envoy_package()
@@ -190,7 +189,7 @@ genrule(
     $(location //tools/docs:sphinx_runner) \\
          --build_sha="$${BUILD_SHA:-}" \\
          --docs_tag="$${DOCS_TAG:-}" \\
-         --version_file=$(location //:VERSION) \\
+         --version_file=$(location //:VERSION.txt) \\
          --validator_path=$(location //tools/config_validation:validate_fragment) \\
          --descriptor_path=$(location //tools/type_whisperer:all_protos_with_ext_pb_text.pb_text) \\
          $(location rst) \\
@@ -201,6 +200,6 @@ genrule(
         ":rst",
         "//tools/config_validation:validate_fragment",
         "//tools/type_whisperer:all_protos_with_ext_pb_text.pb_text",
-        "//:VERSION",
+        "//:VERSION.txt",
     ],
 )

bazel/repositories.bzl

@@ -13,6 +13,7 @@ Minor Behavior Changes
 *Changes that may cause incompatibilities for some users, but should not for most*
 
 * access_log: log all header values in the grpc access log.
+* build: ``VERSION`` and ``API_VERSION`` have been renamed to ``VERSION.txt`` and ``API_VERSION.txt`` respectively to avoid conflicts with the C++ ``<version>`` header.
 * config: warning messages for protobuf unknown fields now contain ancestors for easier troubleshooting.
 * decompressor: decompressor does not duplicate `accept-encoding` header values anymore. This behavioral change can be reverted by setting runtime guard ``envoy.reloadable_features.append_to_accept_content_encoding_only_once`` to false.
 * dynamic_forward_proxy: if a DNS resolution fails, failing immediately with a specific resolution error, rather than finishing up all local filters and failing to select an upstream host.

docs/BUILD

@@ -2,7 +2,7 @@
 
 namespace Envoy {
 
-// TODO(ggreenway): replace 'latest' with the current version, pulled from the VERSION file at
+// TODO(ggreenway): replace 'latest' with the current version, pulled from the VERSION.txt file at
 // the root of the repo.
 #define ENVOY_DOC_URL_ROOT "https://www.envoyproxy.io/docs/envoy/latest"
 

docs/root/version_history/current.rst

@@ -12,15 +12,15 @@ envoy_package()
 
 genrule(
     name = "generate_version_number",
-    srcs = ["//:VERSION"],
+    srcs = ["//:VERSION.txt"],
     outs = ["version_number.h"],
     cmd = """echo "#define BUILD_VERSION_NUMBER \\"$$(cat $<)\\"" >$@""",
     visibility = ["//visibility:private"],
 )
 
 genrule(
     name = "generate_api_version_number",
-    srcs = ["//:API_VERSION"],
+    srcs = ["//:API_VERSION.txt"],
     outs = ["api_version_number.h"],
     cmd = """./$(location //tools/api_versioning:generate_api_version_header_bin) $< >$@""",
     tools = ["//tools/api_versioning:generate_api_version_header_bin"],

source/common/common/documentation_url.h

@@ -53,7 +53,7 @@ envoy_sh_test(
     srcs = ["version_out_test.sh"],
     coverage = False,
     data = [
-        "//:VERSION",
+        "//:VERSION.txt",
         "//bazel:raw_build_id.ldscript",
         "//source/exe:envoy-static",
     ],

source/common/version/BUILD

@@ -20,7 +20,7 @@ fi
 VERSION=$(${ENVOY_BIN} --version | \
   sed -n -E 's/.*version: ([0-9a-f]{40})\/([0-9]+\.[0-9]+\.[0-9]+)(-[a-zA-Z0-9\-_]+)?\/(Clean|Modified)\/(RELEASE|DEBUG)\/([a-zA-Z-]+)$/\2\3/p')
 
-EXPECTED=$(cat "${TEST_SRCDIR}/envoy/VERSION")
+EXPECTED=$(cat "${TEST_SRCDIR}/envoy/VERSION.txt")
 
 if [[ "${VERSION}" != "${EXPECTED}" ]]; then
   echo "Version mismatch, got: ${VERSION}, expected: ${EXPECTED}".

test/exe/BUILD

@@ -24,7 +24,7 @@ def generate_header_file(input_path):
     correct value.
 
     Args:
-        input_path: the file containing the API version (API_VERSION).
+        input_path: the file containing the API version (API_VERSION.txt).
 
     Returns:
         the header file contents.

test/exe/version_out_test.sh

@@ -16,7 +16,7 @@ def get_api_version(input_path):
     """Returns the API version from a given API version input file.
 
     Args:
-      input_path: the file containing the API version (API_VERSION).
+      input_path: the file containing the API version (API_VERSION.txt).
 
     Returns:
       a namedtuple containing the major, minor, patch versions.

tools/api_versioning/generate_api_version_header.py

@@ -145,7 +145,7 @@ def proto_print(src, dst):
         'bazel-bin/tools/protoxform/protoprint', src,
         str(dst),
         './bazel-bin/tools/protoxform/protoprint.runfiles/envoy/tools/type_whisperer/api_type_db.pb_text',
-        'API_VERSION'
+        'API_VERSION.txt'
     ])
 
 

tools/api_versioning/utils.py

@@ -30,7 +30,7 @@ py_binary(
     ],
     data = [
         "//:.clang-format",
-        "//:API_VERSION",
+        "//:API_VERSION.txt",
         "//tools/type_whisperer:api_type_db.pb_text",
     ],
     visibility = ["//visibility:public"],