From 2e729086fa3e4303a6b57f5d751c513fe3b6591b Mon Sep 17 00:00:00 2001 From: Bryan MacFarlane Date: Fri, 17 May 2019 10:38:16 -0400 Subject: [PATCH] spec update --- docs/package-specs.md | 10 ++++++++++ packages/core/README.md | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/docs/package-specs.md b/docs/package-specs.md index f8c9e4e0..76dcecf4 100644 --- a/docs/package-specs.md +++ b/docs/package-specs.md @@ -21,6 +21,16 @@ export function error(message: string): void */ export function exportVariable(name: string, val: string): void +/** + * exports the variable and registers a secret which will get masked from logs + * @param name the name of the variable to set + * @param val value of the secret + */ +export function exportSecret(name: string, val: string) { + exportVariable(name, val); + intm._issueCommand('set-secret', {}, val); +} + /** * Interface for getInput options */ diff --git a/packages/core/README.md b/packages/core/README.md index a4fa04d8..3aca1690 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -19,6 +19,16 @@ export function error(message: string): void */ export function exportVariable(name: string, val: string): void +/** + * exports the variable and registers a secret which will get masked from logs + * @param name the name of the variable to set + * @param val value of the secret + */ +export function exportSecret(name: string, val: string) { + exportVariable(name, val); + intm._issueCommand('set-secret', {}, val); +} + /** * Interface for getInput options */