Skip to content

Commit bc603d8

Browse files
committed
Add pants-plugins/macros.py to pants-plugins/README.md
1 parent 1ab013c commit bc603d8

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

pants-plugins/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ These StackStorm-specific plugins might be useful in other StackStorm-related re
1616

1717
These StackStorm-specific plugins are probably only useful for the st2 repo.
1818
- `api_spec`
19+
- `macros.py` (not a plugin - see pants.toml `[GLOBAL].build_file_prelude_globs`)
1920
- `sample_conf`
2021
- `schemas`
2122

@@ -32,6 +33,16 @@ This plugin also wires up pants so that the `lint` goal runs additional
3233
api spec validation on `st2common/st2common/openapi.yaml` with something
3334
like `./pants lint st2common/st2common/openapi.yaml`.
3435

36+
### `macros.py` macros
37+
38+
[Macros](https://www.pantsbuild.org/docs/macros) are a pants feature
39+
that can reduce "boilerplate"/duplication in BUILD files. The functions
40+
defined in `macros.py` are available in all the BUILD files, and using
41+
them looks just like using the normal BUILD targets.
42+
43+
For documentation about our macros, please refer to the function docstrings
44+
in the `macros.py` file.
45+
3546
### `pack_metadata` plugin
3647

3748
This plugin adds two new targets to pants:

0 commit comments

Comments
 (0)