From f481b8c8dcbe245318cd220b0016650b3d1b1e1c Mon Sep 17 00:00:00 2001 From: Francesco Renzi Date: Thu, 25 May 2023 11:00:25 +0100 Subject: [PATCH] Update docs for setSecret --- docs/commands.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/commands.md b/docs/commands.md index c711368a..5af0f319 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -50,7 +50,18 @@ 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`. -**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** The add-mask and setSecret commands only support single-line +secrets or multi-line secrets that have been escaped. `@actions/core` +`setSecret` will escape the string you provide by default. When an escaped +multi-line string is provided the whole string and each of its lines +individually will be masked. For example you can mask `first\nsecond\r\nthird` +using: + +```sh +echo "::add-mask::first%0Asecond%0D%0Athird" +``` + +This will mask `first%0Asecond%0D%0Athird`, `first`, `second` and `third`. **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`