Skip to content

Commit f55b50f

Browse files
committed
chore: minor README improvements
1 parent c1d1d88 commit f55b50f

File tree

1 file changed

+6
-39
lines changed

1 file changed

+6
-39
lines changed

README.md

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,21 @@
22

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

5+
## Relationship to bazel-skylib
6+
57
This module depends on [bazel-skylib](https://github.com/bazelbuild/bazel-skylib).
68
In theory all these utilities could be upstreamed to bazel-skylib, but the declared scope of that project
7-
is narrow and it's very difficult to get anyone's attention to review PRs there.
9+
is narrow and it no longer accepts feature requests, see https://github.com/orgs/bazelbuild/discussions/3.
10+
It's possible that we may instead remove the dependency on bazel-skylib and entirely replace it, in an ABI-compatible sense. See https://github.com/bazel-contrib/bazel-lib/issues/927.
811

912
## Installation
1013

1114
Installation instructions are included on each release:
1215
<https://github.com/bazel-contrib/bazel-lib/releases>
1316

1417
To use a commit rather than a release, you can point at any SHA of the repo.
15-
However, this adds more "dev dependencies", as you'll have to build our helper programs (such as `copy_to_directory`, `expand_template`) from their Go sources rather than
18+
However, this adds more "dev dependencies", as you'll have to build our helper programs
19+
(such as `copy_to_directory`, `expand_template`) from their Go sources rather than
1620
download pre-built binaries.
1721

1822
For example to use commit `abc123` in `MODULE.bazel`:
@@ -38,40 +42,3 @@ Or in `WORKSPACE`:
3842

3943
> Note that GitHub source archives don't have a strong guarantee on the sha256 stability, see
4044
> <https://github.blog/2023-02-21-update-on-the-future-stability-of-source-code-archives-and-hashes>
41-
42-
# Public API
43-
44-
## Copying files
45-
46-
- [copy_directory](docs/copy_directory.md) Copies directories to another package.
47-
- [copy_file](docs/copy_file.md) Copies files to another package.
48-
- [copy_to_bin](docs/copy_to_bin.md) Copies a source file to output tree at the same workspace-relative path.
49-
- [copy_to_directory](docs/copy_to_directory.md) Copies and arranges files and directories into a new directory.
50-
- [write_source_files](docs/write_source_files.md) 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.
51-
52-
## Manipulating paths
53-
54-
- [directory_path](docs/directory_path.md) Provide a label to reference some path within a directory, via DirectoryPathInfo.
55-
- [output_files](docs/output_files.md) Forwards a subset of the files (via the DefaultInfo provider) from a given target's DefaultInfo or OutputGroupInfo.
56-
57-
## Writing rules
58-
59-
- [expand_make_vars](docs/expand_make_vars.md) Perform make variable and location substitutions in strings..
60-
- [expand_template](docs/expand_template.md) Substitute templates with make variables, location resolves, stamp variables, and arbitrary strings.
61-
- [paths](docs/paths.md) Useful path resolution methods.
62-
- [transitions](docs/transitions.md) Transition sources to a provided platform.
63-
- [lists](docs/lists.md) Functional-style helpers for working with list data structures.
64-
- [utils](docs/utils.md) Various utils for labels and globs.
65-
- [params_file](docs/params_file.md) Generate encoded params file from a list of arguments.
66-
- [repo_utils](docs/repo_utils.md) Useful methods for repository rule implementations.
67-
- [run_binary](docs/run_binary.md) Like skylib's run_binary but adds directory output support.
68-
- [stamping](docs/stamping.md) Support version stamping in custom rules.
69-
- [base64](docs/base64.md) Starlark Base64 encoder & decoder.
70-
71-
## Testing
72-
73-
- [bats_test](docs/bats.md): A test runner for the [Bash Automated Testing System](https://github.com/bats-core/bats-core).
74-
75-
## Generating documentation
76-
77-
- [docs](docs/docs.md) Rules for generating docs and stamping tests to ensure they are up to date.

0 commit comments

Comments
 (0)