actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

Update docs/commands.md 

Co-authored-by: John Wesley Walker III <81404201+jww3@users.noreply.github.com>
pull/1427/head
Francesco Renzi 2023-05-22 16:36:28 +01:00 committed by Francesco Renzi
parent 5ccbd5f448
commit 63ffaaf25e
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/commands.md
View File

@ -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`. 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 **WARNING** The add-mask command only supports single-line secrets. To register
a multiline secret you must register each line individually otherwise it will a multi-line secret, the recommended practice is to register each line individually. Otherwise, it will
not be masked, if you use `@actions/core >= 1.11.0` `setSecret` will do this not be masked. `@actions/core >= 1.11.0` `setSecret` will perform this automatically.
for you.
**WARNING** Do **not** mask short values if you can avoid it, it could render your output unreadable (and future steps' output as well). **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` For example, if you mask the letter `l`, running `echo "Hello FOO BAR World"` will now print `He*********o FOO BAR Wor****d`