Skip to content

Commit ea46bb6

Browse files
committed
chore(docs): Add generic YAML & TOML updaters
1 parent 8675db8 commit ea46bb6

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

docs/customizing.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,3 +201,41 @@ configuration.
201201
]
202202
}
203203
```
204+
205+
## Updating arbitrary YAML files
206+
207+
For most release strategies, you can provide additional files to update
208+
using the [GenericYaml](/src/updaters/generic-yaml.ts) updater. You can
209+
specify a configuration object in the `extra-files` option in the manifest
210+
configuration.
211+
212+
```json
213+
{
214+
"extra-files": [
215+
{
216+
"type": "yaml",
217+
"path": "path/to/file.yaml",
218+
"xpath": "$.json.path.to.field"
219+
}
220+
]
221+
}
222+
```
223+
224+
## Updating arbitrary TOML files
225+
226+
For most release strategies, you can provide additional files to update
227+
using the [GenericToml](/src/updaters/generic-toml.ts) updater. You can
228+
specify a configuration object in the `extra-files` option in the manifest
229+
configuration.
230+
231+
```json
232+
{
233+
"extra-files": [
234+
{
235+
"type": "toml",
236+
"path": "path/to/file.toml",
237+
"xpath": "$.json.path.to.field"
238+
}
239+
]
240+
}
241+
```

0 commit comments

Comments
 (0)