Skip to content

Commit 5ed3a51

Browse files
author
Irene Alvarado
committed
Document new mask param
1 parent 5c3a038 commit 5ed3a51

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,19 @@ In `http` mode this can be anything. This can be any endpoint: a json, csv, txt,
9999

100100
A path to a local Deno javascript or typescript file for postprocessing the `downloaded_filename` file. Read more in the ["Postprocessing section"](https://github.com/githubocto/flat#postprocessing).
101101

102+
#### `mask` (optional)
103+
104+
If your `http_url` string contains secrets, you can choose to mask it from the commit message. You have two options:
105+
106+
**Option 1**: use a string boolean
107+
108+
`mask: true # removes the source entirely from the commit message, defaults to false`
109+
110+
**Option 2**: use a string array with each secret to mask
111+
112+
`mask: '["${{ secrets.SECRET1 }}", "${{ secrets.SECRET2 }}"]'`
113+
114+
102115
### SQL Mode
103116
104117
#### `sql_connstring`

0 commit comments

Comments
 (0)