vaticle / bazel-distribution

Bazel rules for assembling and deploying software distributions (see @vaticle for usage example)
https://bazel.build
Apache License 2.0
155 stars 53 forks source link

Document how to add this as dependency #410

Open hofbi opened 2 months ago

hofbi commented 2 months ago

I would greate to have a short documentation in the readme on how to add this as a dependency to your project.

Should be also related to https://github.com/vaticle/bazel-distribution/issues/370, since bzlmod simplifies the setup.

alexjpwalker commented 3 weeks ago

Agreed, this would be in line with other Bazel rules repos whose root README is typically installation instructions

For anyone coming across this issue in the meantime try

# deps.bzl
load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

def vaticle_bazel_distribution():
    git_repository(
        name = "vaticle_bazel_distribution",
        remote = "https://github.com/vaticle/bazel-distribution",
        commit = "0040e492db47eb83681a62ddf8491a7218633164",
    )
# WORKSPACE
load("//:deps.bzl", "vaticle_bazel_distribution")
vaticle_bazel_distribution()

# load modules you need from bazel_distribution here, e.g:
load("@vaticle_bazel_distribution//common:deps.bzl", "rules_pkg")
rules_pkg()
load("@rules_pkg//:deps.bzl", "rules_pkg_dependencies")
rules_pkg_dependencies()

source: https://github.com/vaticle/typedb/blob/development/WORKSPACE

We haven't yet migrated to Bzlmod but there is an open PR that would initiate the process, Bzlmod instructions will be released as they become available.