https://github.com/filmil/bazel-rules-bid
Bazel rules for building-in-docker
https://github.com/filmil/bazel-rules-bid
Last synced: 23 days ago
JSON representation
Bazel rules for building-in-docker
- Host: GitHub
- URL: https://github.com/filmil/bazel-rules-bid
- Owner: filmil
- License: apache-2.0
- Created: 2023-02-16T08:44:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T08:11:45.000Z (about 2 months ago)
- Last Synced: 2025-03-13T09:19:44.508Z (about 2 months ago)
- Language: Starlark
- Size: 49.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bazel rules for "build-in-docker" (or "bid")
## What is "build-in-docker" (bid)?
Bid allows you to create a build rule that runs a *single* bazel build action inside a
Docker container.
## What is bid *not*?
* Bid is *different* from https://github.com/bazelbuild/rules_docker. Those are
Bazel rules for building containers.
* Bid is also *different* from running bazel from a container described at
https://bazel.build/install/docker-container. That is a way to run the *entire* bazel
build inside a docker container.
## Why bid?
This is a refactoring of a hack I did for https://github.com/filmil/bazel-ebook.
The ebook toolchain setup was very complex. It included installing plenty of
Python, pandoc and dependencies, which are notoriously hard to get right.
I worked around the whole issue by creating a Docker container which has a
regular Debian system with all the tools installed, and writing bazel rules that
invoke that container in build steps.
## How to use bid?
Declare it in your `WORKSPACE` file.
Ensure your `WORKSPACE` file has:
```
load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
```
Then append the following:
```
git_repository(
name = "bazel_rules_bid",
remote = "https://github.com/filmil/bazel-rules-bid.git",
commit = "04b599ec790fe4572dfb851e145c791cb5022c15",
shallow_since = "1676537869 -0800"
)
load("@bazel_rules_bid//build:repositories.bzl", "bazel_bid_repositories")
bazel_bid_repositories()
```
See the [example][ex] in Bazel-ebook on how to use it then.
Mostly you use the rule to prepend the appropriate docker command
line and container name to what you actually want to run in the
docker container. The script takes care that all needed
directories are made available to the docker container when it
runs.
The first time you run the rule, it may take considerable time
for your container to get downloaded. Once it is, however, you
are good to go.
[ex]: https://github.com/filmil/bazel-ebook/blob/main/build/rules.bzl#L27