Skip to main content

Buildfile

The buildfile plugin is a package provider that scans the workspace for BUILD files containing Starlark code and parses target definitions from them. It evaluates each BUILD file as Starlark to extract targets along with their drivers, configuration, labels, and transitive dependencies, then hands those targets to the build engine. BUILD file naming is customizable through glob patterns, and load() statements let you share symbols across BUILD files so common definitions can be reused throughout the workspace.

Provider​

A provider discovers targets and makes them available to the build engine without running any of the work itself; the actual execution is delegated to whatever driver each target names.

Enabling it​

Built-in. Register in .hephconfig under providers with name buildfile. The plugin scans the workspace for BUILD files (or custom patterns) and automatically makes those targets available to the build engine.

Configuration​

Register the provider and, optionally, tune which file names it treats as BUILD files:

.hephconfig
providers:
  - name: buildfile
    options:
      patterns:
        - BUILD
        - "*.BUILD"

Usage​

A matching BUILD file defines targets by calling target() in Starlark:

BUILD
target(
    name = "hello",
    driver = "sh",
    run = ["echo hello"],
)