Skip to content

Commit 48be155

Browse files
authored
add makefile readme (#47)
Signed-off-by: Pavel Okhlopkov <[email protected]>
1 parent 8f644a0 commit 48be155

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,19 @@ If you want to test your JQ filter, you can use JQ helper like in example [here]
196196
5) After executing hook, addon operator process hook output
197197

198198
#### Calling hook
199-
1) Addon operator create temporary files for input and output data (see ENV for examples)
200-
2) Addon operator execute hook with corresponding ID and ENV variables pointed to files
201-
3) Hook reads all files and pass incoming data in HookInput
202-
4) Hook executes and write all resulting data from collectors contained in HookInput
199+
1) Addon operator creates temporary files for input and output data (see ENV for examples)
200+
2) Addon operator executes hook with corresponding ID and ENV variables pointed to files
201+
3) Hook reads all files and passes incoming data in HookInput
202+
4) Hook executes and writes all resulting data from collectors contained in HookInput
203203
5) Addon operator reads info from temporary output files
204+
205+
### Development Commands
206+
207+
Here are some useful commands from the Makefile to help with development:
208+
209+
| Command | Description |
210+
| --- | --- |
211+
| `make test` | Run all tests |
212+
| `make lint` | Run linters to check code quality |
213+
| `make examples` | Test example modules |
214+
| `make go-module-version` | Get current commit "go get" command |

0 commit comments

Comments
 (0)