Skip to content

Common functionality for Google's open-source libraries that are built with bazel.

License

Notifications You must be signed in to change notification settings

google/bazel-common

Bazel Common Libraries

This repository contains assorted common functionality for Google's open-source libraries that are built with bazel. It is an experimental project and none of the APIs/target names are fixed/guaranteed to remain. You are welcome to use it and offer feedback at your own risk.

This is not an official Google product.

Using Bazel Common

  1. Choose the commit hash you want to use.

  2. Compute the SHA-256 value by running:

    curl "https://github.com/google/bazel-common/archive/$COMMIT.zip" | sha256sum
  3. Add the following to your WORKSPACE file, replacing _COMMIT_ with the commit hash and _SHA256_ with the SHA-256 value.

    load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
    
    http_archive(
        name = "google_bazel_common",
        sha256 = "_SHA256_",
        strip_prefix = "bazel-common-_COMMIT_",
        urls = ["https://github.com/google/bazel-common/archive/_COMMIT_.zip"],
    )
    
    load("@google_bazel_common//:workspace_defs.bzl", "google_common_workspace_rules")
    
    google_common_workspace_rules()

To update the version of Bazel Common, choose a new commit and update your WORKSPACE file.

Incrementing the version of an exported library

  1. Run update_version, passing the group, artifact ID, and version you want to update:

    $ update_version com.google.guava guava 31.0.1-jre

    If several artifacts share the same version via a variable, such as ERROR_PRONE_VERSION, you can pass just the variable and the new version:

    $ update_version ERROR_PRONE_VERSION 2.3.2
  2. Send the change for review.

  3. Once submitted, remember to update your own dep on bazel_common to the version containing your change.

If update_version doesn't work

  1. Open workspace_defs.bzl

  2. Find the library export you want to increment

  3. Update the version attribute to the new value

  4. Update the sha256 attribute to the value obtained by running:

    curl "https://repo1.maven.org/maven2/${group_id//.//}/${artifact_id}/${version}/${artifact_id}-${version}.jar" | sha256sum

    TIP: Double-check that the download is the size you expect

  5. Return to step 2 above.

About

Common functionality for Google's open-source libraries that are built with bazel.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published