Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Save TF wheel version and suffix in repository rule. #3073

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .bazelrc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,16 @@

# Default build options. These are applied first and unconditionally.

# These are used to generate the ML wheel version string.
# See the explanation in the file comment of
# @tsl//third_party/py/python_wheel_version_suffix.bzl.
# The generated version suffix is used in
# third_party/tensorflow/core/public/version.h and
# third_party/tensorflow/tools/pip_package/setup.oss.py.tpl
build --repo_env=ML_WHEEL_TYPE="snapshot"
build --repo_env=ML_WHEEL_BUILD_DATE=""
build --repo_env=ML_WHEEL_VERSION_SUFFIX=""

# For projects which use TensorFlow as part of a Bazel build process, putting
# nothing in a bazelrc will default to a monolithic build. The following line
# opts in to modular op registration support by default.
Expand Down
1 change: 1 addition & 0 deletions opensource_only.files
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ third_party/py/python_init_repositories.bzl:
third_party/py/python_init_rules.bzl:
third_party/py/python_init_toolchains.bzl:
third_party/py/python_repo.bzl:
third_party/py/python_wheel_version_suffix.bzl:
third_party/pybind11.BUILD:
third_party/pybind11_bazel/BUILD:
third_party/python_runtime/BUILD:
Expand Down
2 changes: 1 addition & 1 deletion third_party/py/manylinux_compliance_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def verify_manylinux_compliance(
Raises:
RuntimeError: if the wheel is not manyLinux compliant.
"""
regex = 'following platform tag: "{}"'.format(compliance_tag)
regex = 'following platform tag:\s+"{}"'.format(compliance_tag)
if not re.search(regex, auditwheel_log):
raise RuntimeError(
("The wheel is not compliant with the tag {tag}.\n{result}").format(
Expand Down
113 changes: 113 additions & 0 deletions third_party/py/python_wheel_version_suffix.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
"""
Repository rule to manage wheel version suffix string.

The calculated version suffix depends on the wheel type:
- nightly: .dev{build_date}
- release: ({custom_version_suffix})?
- custom: .dev{build_date}(+{git_hash})?({custom_version_suffix})?
- snapshot (default): -0

The following environment variables can be set via the build parameters:
{wheel_type}: ML_WHEEL_TYPE
{build_date}: ML_WHEEL_BUILD_DATE
{git_hash}: ML_WHEEL_GIT_HASH
{custom_version_suffix}: ML_WHEEL_VERSION_SUFFIX

Examples:
1. nightly wheel version: 2.19.0.dev20250107
Build parameters: --repo_env=ML_WHEEL_TYPE=nightly
--repo_env=ML_WHEEL_BUILD_DATE=20250107
2. release wheel version: 2.19.0
Build parameters: --repo_env=ML_WHEEL_TYPE=release
3. release candidate wheel version: 2.19.0-rc1
Build parameters: --repo_env=ML_WHEEL_TYPE=release
--repo_env=ML_WHEEL_VERSION_SUFFIX=-rc1
4. custom wheel version: 2.19.0.dev20250107+cbe478fc5-custom
Build parameters: --repo_env=ML_WHEEL_TYPE=custom
--repo_env=ML_WHEEL_BUILD_DATE=$(git show -s --format=%as HEAD)
--repo_env=ML_WHEEL_GIT_HASH=$(git rev-parse HEAD)
--repo_env=ML_WHEEL_VERSION_SUFFIX=-custom
5. snapshot wheel version: 2.19.0-0
Build parameters: --repo_env=ML_WHEEL_TYPE=snapshot

"""

load(
"//third_party/remote_config:common.bzl",
"get_host_environ",
)

def _python_wheel_version_suffix_repository_impl(repository_ctx):
wheel_type = get_host_environ(
repository_ctx,
_ML_WHEEL_WHEEL_TYPE,
"snapshot",
)
build_date = get_host_environ(repository_ctx, _ML_WHEEL_BUILD_DATE)
git_hash = get_host_environ(repository_ctx, _ML_WHEEL_GIT_HASH)
custom_version_suffix = get_host_environ(
repository_ctx,
_ML_WHEEL_VERSION_SUFFIX,
)

if wheel_type not in ["release", "nightly", "snapshot", "custom"]:
fail("Environment variable ML_WHEEL_TYPE should have values \"release\", \"nightly\", \"custom\" or \"snapshot\"")

wheel_version_suffix = ""
semantic_wheel_version_suffix = ""
build_tag = ""
if wheel_type == "nightly":
if not build_date:
fail("Environment variable ML_BUILD_DATE is required for nightly builds!")
formatted_date = build_date.replace("-", "")
wheel_version_suffix = ".dev{}".format(formatted_date)
semantic_wheel_version_suffix = "-dev{}".format(formatted_date)
elif wheel_type == "release":
if custom_version_suffix:
wheel_version_suffix = custom_version_suffix.replace("-", "")
semantic_wheel_version_suffix = custom_version_suffix
elif wheel_type == "custom":
if build_date:
formatted_date = build_date.replace("-", "")
wheel_version_suffix += ".dev{}".format(formatted_date)
semantic_wheel_version_suffix = "-dev{}".format(formatted_date)
if git_hash:
formatted_hash = git_hash[:9]
wheel_version_suffix += "+{}".format(formatted_hash)
semantic_wheel_version_suffix += "+{}".format(formatted_hash)
if custom_version_suffix:
wheel_version_suffix += custom_version_suffix.replace("-", "")
semantic_wheel_version_suffix += custom_version_suffix
else:
build_tag = "0"

version_suffix_bzl_content = """WHEEL_VERSION_SUFFIX = '{wheel_version_suffix}'
SEMANTIC_WHEEL_VERSION_SUFFIX = '{semantic_wheel_version_suffix}'
BUILD_TAG = '{build_tag}'""".format(
wheel_version_suffix = wheel_version_suffix,
semantic_wheel_version_suffix = semantic_wheel_version_suffix,
build_tag = build_tag,
)

repository_ctx.file(
"wheel_version_suffix.bzl",
version_suffix_bzl_content,
)
repository_ctx.file("BUILD", "")

_ML_WHEEL_WHEEL_TYPE = "ML_WHEEL_TYPE"
_ML_WHEEL_BUILD_DATE = "ML_WHEEL_BUILD_DATE"
_ML_WHEEL_GIT_HASH = "ML_WHEEL_GIT_HASH"
_ML_WHEEL_VERSION_SUFFIX = "ML_WHEEL_VERSION_SUFFIX"

_ENVIRONS = [
_ML_WHEEL_WHEEL_TYPE,
_ML_WHEEL_BUILD_DATE,
_ML_WHEEL_GIT_HASH,
_ML_WHEEL_VERSION_SUFFIX,
]

python_wheel_version_suffix_repository = repository_rule(
implementation = _python_wheel_version_suffix_repository_impl,
environ = _ENVIRONS,
)