Common useful functions for writing BUILD files and Starlark macros/rules
Go to file
Greg Magolan abbbd54a15
chore: right size tests to supress bazel warning (#913)
2024-08-19 15:55:21 -07:00
.aspect chore: turn off bzlmod misguided warning (#901) 2024-08-14 10:41:50 -07:00
.bcr chore: bump buildifier, go and gazelle deps (#845) 2024-05-13 23:30:19 -07:00
.circleci chore: upgrade to Aspect Workflows 5.10.9 (#881) 2024-07-18 17:54:51 -07:00
.github/workflows refactor(release): switch release integrity to be dynamic (#854) 2024-05-23 16:08:35 -07:00
docs fix: correctly split quoted args (#909) 2024-08-19 16:36:41 -04:00
e2e chore: green up CI on main branch (#904) 2024-08-14 11:31:04 -07:00
lib chore: right size tests to supress bazel warning (#913) 2024-08-19 15:55:21 -07:00
platforms
shlib chore: right size tests to supress bazel warning (#913) 2024-08-19 15:55:21 -07:00
tools chore: bazel run //:buildifier (#903) 2024-08-14 11:27:58 -07:00
.bazelignore
.bazeliskrc chore: bump to Bazel 7.1.2 (#842) 2024-05-13 21:28:28 -07:00
.bazelrc chore: add --check_direct_dependencies to .bazelrc (#864) 2024-06-07 11:49:45 -07:00
.bazelversion chore: bump to Bazel 7.1.2 (#842) 2024-05-13 21:28:28 -07:00
.editorconfig
.gitattributes fix(typos): Fix almost all typos with hook (#884) 2024-07-31 10:09:17 -04:00
.gitignore chore: align ci patterns (#843) 2024-05-13 23:51:10 -07:00
.pre-commit-config.yaml fix(typos): Fix almost all typos with hook (#884) 2024-07-31 10:09:17 -04:00
.prettierignore
.typos.toml fix(typos): Fix almost all typos with hook (#884) 2024-07-31 10:09:17 -04:00
BUILD.bazel fix(tar): append slash to top-level directory mtree entries (#852) 2024-07-02 09:27:06 -07:00
CONTRIBUTING.md
LICENSE
MODULE.bazel fix: add bzlmod use_repo of org_golang_x_sys (#896) 2024-08-08 17:57:03 -07:00
README.md chore(typos): Add typos hook plus some fixes (#637) 2024-07-19 22:10:26 -07:00
WORKSPACE chore(deps): upgrade stardoc (#894) 2024-08-08 12:56:11 -07:00
deps.bzl chore: bazel run //:gazelle_update_repos (#895) 2024-08-08 14:55:16 -07:00
go.mod fix(deps): update golang.org/x/exp digest to 1b97071 2024-01-30 00:19:09 -08:00
go.sum fix(deps): update golang.org/x/exp digest to 1b97071 2024-01-30 00:19:09 -08:00
internal_deps.bzl chore(deps): upgrade stardoc (#894) 2024-08-08 12:56:11 -07:00
renovate.json Update renovate.json (#572) 2024-02-26 17:39:52 -08:00

README.md

Aspect's Bazel helpers library

Base Starlark libraries and basic Bazel rules which are useful for constructing rulesets and BUILD files.

This module depends on bazel-skylib. In theory all these utilities could be upstreamed to bazel-skylib, but the declared scope of that project is narrow and it's very difficult to get anyone's attention to review PRs there.

bazel-lib is just a part of what Aspect provides:

Installation

Installation instructions are included on each release: https://github.com/aspect-build/bazel-lib/releases

To use a commit rather than a release, you can point at any SHA of the repo.

For example to use commit abc123:

  1. Replace url = "https://github.com/aspect-build/bazel-lib/releases/download/v0.1.0/bazel-lib-v0.1.0.tar.gz" with a GitHub-provided source archive like url = "https://github.com/aspect-build/bazel-lib/archive/abc123.tar.gz"
  2. Replace strip_prefix = "bazel-lib-0.1.0" with strip_prefix = "bazel-lib-abc123"
  3. Update the sha256. The easiest way to do this is to comment out the line, then Bazel will print a message with the correct value.

Note that GitHub source archives don't have a strong guarantee on the sha256 stability, see https://github.blog/2023-02-21-update-on-the-future-stability-of-source-code-archives-and-hashes

Public API

Copying files

  • copy_directory Copies directories to another package.
  • copy_file Copies files to another package.
  • copy_to_bin Copies a source file to output tree at the same workspace-relative path.
  • copy_to_directory Copies and arranges files and directories into a new directory.
  • write_source_files Write to one or more files or folders in the source tree. Stamp out tests that ensure the sources exist and are up to date.

Transforming files

  • jq A toolchain and custom rule for running jq, a tool that is "like sed for json".
  • yq A toolchain and custom rule for running yq, a "YAML, JSON and XML processor".

Manipulating paths

  • directory_path Provide a label to reference some path within a directory, via DirectoryPathInfo.
  • output_files Forwards a subset of the files (via the DefaultInfo provider) from a given target's DefaultInfo or OutputGroupInfo.

Writing rules

  • expand_make_vars Perform make variable and location substitutions in strings..
  • expand_template Substitute templates with make variables, location resolves, stamp variables, and arbitrary strings.
  • paths Useful path resolution methods.
  • transitions Transition sources to a provided platform.
  • lists Functional-style helpers for working with list data structures.
  • utils Various utils for labels and globs.
  • params_file Generate encoded params file from a list of arguments.
  • repo_utils Useful methods for repository rule implementations.
  • run_binary Like skylib's run_binary but adds directory output support.
  • stamping Support version stamping in custom rules.
  • base64 Starlark Base64 encoder & decoder.

Testing

Generating documentation

  • docs Rules for generating docs and stamping tests to ensure they are up to date.