gha-utils/dist/log.d.ts

A minimalistic utility package for developing GitHub Actions

/**
 * Logs an information message in GitHub Actions.
 *
 * @param message - The information message to log.
 */
export declare function logInfo(message: string): void;
/**
 * Logs a debug message in GitHub Actions.
 *
 * @param message - The debug message to log.
 */
export declare function logDebug(message: string): void;
/**
 * Logs a warning message in GitHub Actions.
 *
 * @param message - The warning message to log.
 */
export declare function logWarning(message: string): void;
/**
 * Logs an error message in GitHub Actions.
 *
 * @param err - The error, which can be of any type.
 */
export declare function logError(err: unknown): void;
/**
 * Logs a command along with its arguments in GitHub Actions.
 *
 * @param command - The command to log.
 * @param args - The arguments of the command.
 */
export declare function logCommand(command: string, ...args: string[]): void;
/**
 * Begins a log group in GitHub Actions.
 *
 * @param name - The name of the log group.
 */
export declare function beginLogGroup(name: string): void;
/**
 * Ends the current log group in GitHub Actions.
 */
export declare function endLogGroup(): void;