Common useful functions for writing BUILD files and Starlark macros/rules
Go to file
thesayyn d6bfb1ec7d
feat: implement is_exec_platform_windows
2023-12-21 11:18:25 -08:00
.aspect chore: switch to smaller 'small' instances without nvme drives (#700) 2023-12-19 22:25:17 -08:00
.bcr fix: exclude bazeliskrc from smoke test (#654) 2023-11-14 15:39:56 -08:00
.circleci chore: switch to smaller 'small' instances without nvme drives (#700) 2023-12-19 22:25:17 -08:00
.github/workflows chore: bazel run //:format (#682) 2023-12-08 00:30:39 -08:00
docs feat: implement bats test runner (#699) 2023-12-20 13:08:47 -08:00
e2e feat: implement bats test runner (#699) 2023-12-20 13:08:47 -08:00
lib feat: implement is_exec_platform_windows 2023-12-21 11:18:25 -08:00
platforms ci: enable engflow RBE for github actions 2022-08-19 08:42:00 -07:00
shlib chore: bazel run //:format (#682) 2023-12-08 00:30:39 -08:00
tools chore: enable workflows delivery on demostration target (#693) 2023-12-13 17:26:35 -08:00
.bazelignore chore: turn on more basic precommit checks 2023-02-17 11:00:00 -08:00
.bazeliskrc chore: green up Windows CI (#643) 2023-11-07 14:01:45 -08:00
.bazelrc fix(ci): always build with -c opt (#555) 2023-09-27 09:56:35 -07:00
.bazelversion chore(deps): update dependency bazel to v6.3.2 2023-08-23 17:38:59 -07:00
.editorconfig chore: bazel run //:format (#682) 2023-12-08 00:30:39 -08:00
.gitattributes fix: exclude bazeliskrc from smoke test (#654) 2023-11-14 15:39:56 -08:00
.gitignore Avoid expanding mtree spec during analysis phase (#576) 2023-10-05 12:36:55 -07:00
.pre-commit-config.yaml chore: bring in aspect_rules_lint and add format task to Aspect Workflows (#681) 2023-12-07 23:34:24 -08:00
.prettierignore chore: turn on more basic precommit checks 2023-02-17 11:00:00 -08:00
BUILD.bazel fix: isolate rules_lint dev dependency usage into its own Bazel package (#687) 2023-12-11 07:34:26 -08:00
CONTRIBUTING.md docs: add minimum pre-commit version (#544) 2023-09-24 17:17:49 -07:00
LICENSE chore: turn on more basic precommit checks 2023-02-17 11:00:00 -08:00
MODULE.bazel feat: implement bats test runner (#699) 2023-12-20 13:08:47 -08:00
README.md chore: remove expand_template re-export (#580) 2023-10-05 12:33:13 -07:00
WORKSPACE chore: bring in aspect_rules_lint and add format task to Aspect Workflows (#681) 2023-12-07 23:34:24 -08:00
deps.bzl fix(deps): update golang.org/x/exp digest to f3f8817 2023-12-08 11:52:13 -08:00
go.mod fix(deps): update golang.org/x/exp digest to f3f8817 2023-12-08 11:52:13 -08:00
go.sum fix(deps): update golang.org/x/exp digest to f3f8817 2023-12-08 11:52:13 -08:00
internal_deps.bzl feat: implement bats test runner (#699) 2023-12-20 13:08:47 -08:00
renovate.json chore: update renovate config 2023-02-18 09:23:22 -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 substitions 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.

Generating documentation

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