import {issue, issueCommand} from './command' import {issueCommand as issueFileCommand} from './file-command' import {toCommandValue} from './utils' import * as os from 'os' import * as path from 'path' /** * Interface for getInput options */ export interface InputOptions { /** Optional. Whether the input is required. If required and not present, will throw. Defaults to false */ required?: boolean } /** * The code to exit an action */ export enum ExitCode { /** * A code indicating that the action was successful */ Success = 0, /** * A code indicating that the action was a failure */ Failure = 1 } //----------------------------------------------------------------------- // Variables //----------------------------------------------------------------------- /** * 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. Non-string values will be converted to a string via JSON.stringify */ // eslint-disable-next-line @typescript-eslint/no-explicit-any export function exportVariable(name: string, val: any): void { const convertedVal = toCommandValue(val) process.env[name] = convertedVal const filePath = process.env['GITHUB_ENV'] || '' if (filePath) { const delimiter = '_GitHubActionsFileCommandDelimeter_' const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}` issueFileCommand('ENV', commandValue) } else { issueCommand('set-env', {name}, convertedVal) } } /** * Registers a secret which will get masked from logs * @param secret value of the secret */ export function setSecret(secret: string): void { issueCommand('add-mask', {}, secret) } /** * Prepends inputPath to the PATH (for this action and future actions) * @param inputPath */ export function addPath(inputPath: string): void { const filePath = process.env['GITHUB_PATH'] || '' if (filePath) { issueFileCommand('PATH', inputPath) } else { issueCommand('add-path', {}, inputPath) } process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}` } /** * Gets the value of an input. The value is also trimmed. * * @param name name of the input to get * @param options optional. See InputOptions. * @returns string */ export function getInput(name: string, options?: InputOptions): string { const val: string = process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || '' if (options && options.required && !val) { throw new Error(`Input required and not supplied: ${name}`) } return val.trim() } /** * Gets the input value of the boolean type in the YAML 1.2 "core schema" specification. * Support boolean input list: `true | True | TRUE | false | False | FALSE` . * The return value is also in boolean type. * ref: https://yaml.org/spec/1.2/spec.html#id2804923 * * @param name name of the input to get * @param options optional. See InputOptions. * @returns boolean */ export function getBooleanInput(name: string, options?: InputOptions): boolean { const trueValue = ['true', 'True', 'TRUE'] const falseValue = ['false', 'False', 'FALSE'] const val = getInput(name, options) if (trueValue.includes(val)) return true if (falseValue.includes(val)) return false throw new TypeError( `Input does not meet YAML 1.2 "Core Schema" specification: ${name}\n` + `Support boolean input list: \`true | True | TRUE | false | False | FALSE\`` ) } /** * Sets the value of an output. * * @param name name of the output to set * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ // eslint-disable-next-line @typescript-eslint/no-explicit-any export function setOutput(name: string, value: any): void { process.stdout.write(os.EOL) issueCommand('set-output', {name}, value) } /** * Enables or disables the echoing of commands into stdout for the rest of the step. * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. * */ export function setCommandEcho(enabled: boolean): void { issue('echo', enabled ? 'on' : 'off') } //----------------------------------------------------------------------- // Results //----------------------------------------------------------------------- /** * 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 | Error): void { process.exitCode = ExitCode.Failure error(message) } //----------------------------------------------------------------------- // Logging Commands //----------------------------------------------------------------------- /** * Gets whether Actions Step Debug is on or not */ export function isDebug(): boolean { return process.env['RUNNER_DEBUG'] === '1' } /** * Writes debug message to user log * @param message debug message */ export function debug(message: string): void { issueCommand('debug', {}, message) } /** * Adds an error issue * @param message error issue message. Errors will be converted to string via toString() */ export function error(message: string | Error): void { issue('error', message instanceof Error ? message.toString() : message) } /** * Adds an warning issue * @param message warning issue message. Errors will be converted to string via toString() */ export function warning(message: string | Error): void { issue('warning', message instanceof Error ? message.toString() : message) } /** * Writes info to log with console.log. * @param message info message */ export function info(message: string): void { process.stdout.write(message + os.EOL) } /** * Begin an output group. * * Output until the next `groupEnd` will be foldable in this group * * @param name The name of the output group */ export function startGroup(name: string): void { issue('group', name) } /** * End an output group. */ export function endGroup(): void { issue('endgroup') } /** * Wrap an asynchronous function call in a group. * * Returns the same type as the function itself. * * @param name The name of the group * @param fn The function to wrap in the group */ export async function group(name: string, fn: () => Promise): Promise { startGroup(name) let result: T try { result = await fn() } finally { endGroup() } return result } //----------------------------------------------------------------------- // Wrapper action state //----------------------------------------------------------------------- /** * Saves state for current action, the state can only be retrieved by this action's post job execution. * * @param name name of the state to store * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ // eslint-disable-next-line @typescript-eslint/no-explicit-any export function saveState(name: string, value: any): void { issueCommand('save-state', {name}, value) } /** * Gets the value of an state set by this action's main execution. * * @param name name of the state to get * @returns string */ export function getState(name: string): string { return process.env[`STATE_${name}`] || '' }