Skip to content

Commit

Permalink
Add pants-plugins/macros.py to pants-plugins/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cognifloyd committed Feb 9, 2023
1 parent 1df9176 commit 34d54d8
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions pants-plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ These StackStorm-specific plugins might be useful in other StackStorm-related re

These StackStorm-specific plugins are probably only useful for the st2 repo.
- `api_spec`
- `macros.py` (not a plugin - see pants.toml `[GLOBAL].build_file_prelude_globs`)
- `release`
- `sample_conf`
- `schemas`
Expand All @@ -33,6 +34,16 @@ This plugin also wires up pants so that the `lint` goal runs additional
api spec validation on `st2common/st2common/openapi.yaml` with something
like `./pants lint st2common/st2common/openapi.yaml`.

### `macros.py` macros

[Macros](https://www.pantsbuild.org/docs/macros) are a pants feature
that can reduce "boilerplate"/duplication in BUILD files. The functions
defined in `macros.py` are available in all the BUILD files, and using
them looks just like using the normal BUILD targets.

For documentation about our macros, please refer to the function docstrings
in the `macros.py` file.

### `pack_metadata` plugin

This plugin adds two new targets to pants:
Expand Down

0 comments on commit 34d54d8

Please sign in to comment.