https://github.com/google/bazel-common

Common functionality for Google's open-source libraries that are built with bazel.
https://github.com/google/bazel-common

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/google/bazel-common
• Owner: google
• License: apache-2.0
• Created: 2018-02-28T16:25:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-29T22:25:03.000Z (4 months ago)
• Last Synced: 2024-02-29T23:29:16.614Z (4 months ago)
• Language: Starlark
• Homepage:
• Size: 164 KB
• Stars: 82
• Watchers: 25
• Forks: 46
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-bazel - Bazel Common Libraries - **Java-specific** Common functionality for Google's open-source libraries that are built with Bazel. (Tooling / Starlark)

README

        
# 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.

[`bazel`]: https://bazel.build

## Using Bazel Common

1. Choose the commit hash you want to use.

1. Compute the SHA-256 value by running:

   ```shell

   curl "https://github.com/google/bazel-common/archive/$COMMIT.zip" | sha256sum

   ```

1. Add the following to your `WORKSPACE` file, replacing `_COMMIT_` with the

   commit hash and `_SHA256_` with the SHA-256 value.

   ```bzl

   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:

    ```shell

    $ 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:

    ```shell

    $ 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:

    ```sh

    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.

[`update_version`]: https://github.com/google/bazel-common/blob/master/update_version