Skip to content

Commit

Permalink
note differentiating processor features in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cjnosal committed Jan 12, 2020
1 parent 7bd0958 commit ea7d2fb
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ interpolator:
See [bosh interpolate](https://bosh.io/docs/cli-int/) and [variable types](https://bosh.io/docs/variable-types/) for more details

### processor options
A snippet can override the libraries processor type, or provide options
A snippet can override the library's default processor type, or provide options

#### opsfile processor
```
Expand All @@ -300,18 +300,22 @@ options:
```
See the [go-patch](https://github.com/cppforlife/go-patch) and [ops-file](https://bosh.io/docs/cli-ops-files) docs for more details

Differentiating features: field matching and index selection

#### yq processor
```
type: yq
options:
command: # write, read, delete, prefix, merge
command: # write, read, delete, prefix, merge (default write)
path: # yaml element to read or delete
prefix: # key to nest the current yaml structure under
overwrite: # boolean for merges to replace existing elements
append: # boolean for merges to append new array elements
```
See the [yq docs](https://mikefarah.github.io/yq/) for more details

Differentiating features: wildcards, prefix, and merge

## Invocation
Running `manifer compose --library mainlib.yml --template foo-template.yml --scenario my-use-case` should produce:
```
Expand Down

0 comments on commit ea7d2fb

Please sign in to comment.