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

Add Warning about multiline secrets (#196)

pull/200/head
Thomas Boop 2019-11-01 10:05:01 -04:00 committed by GitHub
parent 4a3fe0bcd3
commit a9ebfb1a78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/commands.md
View File

@ -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`. 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` 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 ### Group and Ungroup Log Lines