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

spec update

pull/4/head
Bryan MacFarlane 2019-05-17 10:04:20 -04:00
parent 2697357344
commit d7423efd98
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/package-specs.md
View File

@ -12,14 +12,6 @@ export function debug(message: string): void
export function warning(message: string): void export function warning(message: string): void
export function error(message: string): void export function error(message: string): void
/**
* Interface for exportVariable options
*/
export interface ExportOptions {
/** Optional. Whether the variable should be marked as secret (will be masked from logs). Defaults to false */
isSecret?: bool;
}
/** /**
* sets env variable for this action and future actions in the job * sets env variable for this action and future actions in the job
* *
@ -27,7 +19,7 @@ export interface ExportOptions {
* @param val the value of the variable * @param val the value of the variable
* @param options optional. See ExportOptions. * @param options optional. See ExportOptions.
*/ */
export function exportVariable(name: string, val: string, options?: ExportOptions): void export function exportVariable(name: string, val: string): void
/** /**
* Interface for getInput options * Interface for getInput options
@ -47,10 +39,16 @@ export interface InputOptions {
export function getInput(name: string, options?: InputOptions): string | undefined export function getInput(name: string, options?: InputOptions): string | undefined
/** /**
* fail the action * sets the status of the action to neutral
* @param message * @param message
*/ */
export function setFailure(message: string): void export function setFailed(message: string): void
/**
* sets the status of the action to failed
* @param message
*/
export function setFailed(message: string): void
``` ```
### IO spec ### IO spec