From a9ebfb1a784bd83f2dceeb60d8ce7f6937f0c049 Mon Sep 17 00:00:00 2001 From: Thomas Boop <52323235+thboop@users.noreply.github.com> Date: Fri, 1 Nov 2019 10:05:01 -0400 Subject: [PATCH] Add Warning about multiline secrets (#196) --- docs/commands.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/commands.md b/docs/commands.md index f2c02bfc..66b0162a 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -81,7 +81,9 @@ function setSecret(secret: string): void {} Now, future logs containing BAR will be masked. E.g. running `echo "Hello FOO BAR World"` will now print `Hello FOO **** World`. -CAUTION: Do **not** mask short values if you can avoid it, it could render your output unreadable (and future steps' output as well). +**WARNING** The add-mask and setSecret commands only support single line secrets. To register a multiline secrets you must register each line individually otherwise it will not be masked. + +**WARNING** Do **not** mask short values if you can avoid it, it could render your output unreadable (and future steps' output as well). For example, if you mask the letter `l`, running `echo "Hello FOO BAR World"` will now print `He*********o FOO BAR Wor****d` ### Group and Ungroup Log Lines