From 63ffaaf25ee5c19b2134856ac2d372f7ce2b1a4a Mon Sep 17 00:00:00 2001 From: Francesco Renzi Date: Mon, 22 May 2023 16:36:28 +0100 Subject: [PATCH] Update docs/commands.md Co-authored-by: John Wesley Walker III <81404201+jww3@users.noreply.github.com> --- docs/commands.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/commands.md b/docs/commands.md index 694639fa..fa68a45a 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -50,10 +50,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`. -**WARNING** The add-mask command only supports single line secrets. To register -a multiline secret you must register each line individually otherwise it will -not be masked, if you use `@actions/core >= 1.11.0` `setSecret` will do this -for you. +**WARNING** The add-mask command only supports single-line secrets. To register +a multi-line secret, the recommended practice is to register each line individually. Otherwise, it will +not be masked. `@actions/core >= 1.11.0` `setSecret` will perform this automatically. **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`