Skip to content

Commit 0080336

Browse files
committed
Add pants-plugins/release to pants-plugins/README.md
1 parent 2266086 commit 0080336

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

pants-plugins/README.md

+9
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+
- `release`
1920
- `sample_conf`
2021
- `schemas`
2122

@@ -52,6 +53,14 @@ If it is not checked out, then some of the tests will fail.
5253
If it is not checked out, `pack_metadata_in_git_submodule` handles providing
5354
a helpful, instructive error message as early as possible.
5455

56+
### `release` plugin
57+
58+
This plugin implements the [`SetupKwargs`](https://www.pantsbuild.org/docs/plugins-setup-py)
59+
plugin hook that pants uses when it auto-generates a `setup.py` file whenever
60+
it builds a `python_distribution()` (ie a wheel or an sdist). This makes it
61+
easy to centralize all of the common bits of metadata that need to go in all
62+
the wheels (like `author="StackStorm"` or our `project_urls`).
63+
5564
### `sample_conf` plugin
5665

5766
This plugin wires up pants to make sure `conf/st2.conf.sample` gets

0 commit comments

Comments
 (0)