1
0
Fork 0
toolkit/packages/core
Danny McCormick 5f31b6acfc Add tests, getInput should be case-insensitive and trim output 2019-05-17 10:31:07 -04:00
..
__tests__ Add tests, getInput should be case-insensitive and trim output 2019-05-17 10:31:07 -04:00
src Add tests, getInput should be case-insensitive and trim output 2019-05-17 10:31:07 -04:00
README.md update inputs and variables 2019-05-17 10:23:01 -04:00
package-lock.json starting on core 2019-05-16 23:36:45 -04:00
package.json Add tests, getInput should be case-insensitive and trim output 2019-05-17 10:31:07 -04:00
tsconfig.json Add Bryan's core code 2019-05-16 16:40:21 -04:00

README.md

@actions/core

Core functions for setting results, logging, registering secrets and exporting variables across actions

Usage

//-----------------------------------------------------------------------
// Variables, Inputs and Outputs
//-----------------------------------------------------------------------

/**
 * sets env variable for this action and future actions in the job
 * @param name the name of the variable to set
 * @param val the value of the variable
 */
export function exportVariable(name: string, val: string);

/**
 * registers a secret which will get masked from logs
 * @param val value of the secret
 */
export function setSecret(name: string, val: string);

// TODO: follow up and see if we need anything for outputs

//-----------------------------------------------------------------------
// Results
//-----------------------------------------------------------------------

/**
 * Sets the action status to neutral
 */
export function setNeutral();

/**
 * Sets the action status to failed.  
 * When the action exits it will be with an exit code of 1
 * @param message add error issue message
 */
export function setFailed(message: string);

//-----------------------------------------------------------------------
// Logging Commands
//-----------------------------------------------------------------------

/**
 * Writes debug message to user log
 * @param message debug message
 */
export function debug(message: string);

/**
 * Adds an error issue
 * @param message error issue message
 */
export function error(message: string);

/**
 * Adds an warning issue
 * @param message warning issue message
 */
export function warning(message: string);