Skip to content

Commit 8714604

Browse files
authored
Update filter-functions.md
1 parent 5f2e195 commit 8714604

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/filter-functions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -922,8 +922,8 @@ Reads the contents of a file from the current branch or the `cm` repo and return
922922
| Argument | Usage | Type | Description |
923923
| -------- | ------ | ------ | ------------------------------------------------------------------- |
924924
| - | Input | String | The relative file path in the current repo. Prepend `../cm/` to get files from the `cm` repo |
925-
| `type` | Input | String | The content type. Optional, `txt` by default. Allowed options are `txt` or `json` |
926-
| - | Output | String | The contents of the file as a string |
925+
| `output` | Input | String | The content type. Optional, `txt` by default. Allowed options are `txt` or `json`. When using `json`, the output will be returned as an Object |
926+
| - | Output | String/ Object | The contents of the file as a String or Object |
927927
</div>
928928

929929
For example, add a comment with a file's content:
@@ -939,5 +939,5 @@ automations:
939939
comment: |
940940
{{ README_CONTENT }}
941941
942-
README_CONTENT: {{ "txt" | readFile("./README.md") | dump }}
942+
README_CONTENT: {{ "txt" | readFile("./README.md") }}
943943
```

0 commit comments

Comments
 (0)