Skip to content

Commit 33b68fd

Browse files
committed
add description of uses_services plugin to pants-plugins/README.md
1 parent ec9e3e4 commit 33b68fd

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

pants-plugins/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ To see available goals, do "./pants help goals" and "./pants help $goal".
1111
These StackStorm-specific plugins are probably only useful for the st2 repo.
1212
- `schemas`
1313

14+
These plugins might be useful outside of the StackStorm project:
15+
- `uses_services`
16+
1417
### `schemas` plugin
1518

1619
This plugin wires up pants to make sure `contrib/schemas/*.json` gets
@@ -19,3 +22,13 @@ the `fmt` goal (eg `./pants fmt contrib/schemas::`), the schemas will
1922
be regenerated if any of the files used to generate them have changed.
2023
Also, running the `lint` goal will fail if the schemas need to be
2124
regenerated.
25+
26+
### `uses_seevices` plugin
27+
28+
This plugin validates that services are running if required. For example, some tests
29+
need mongo, so this plugin can ensure mongo is running. If it is not running, then
30+
an error with instructions on how to run it are given to the user.
31+
32+
`uses_services` has some StackStorm-specific assumptions in it, but it might be
33+
generalizable. There are several other StackStorm-specific plugins, but some of
34+
them are only useful in the st2 repo.

0 commit comments

Comments
 (0)