mirror of
https://github.com/dawidd6/action-send-mail.git
synced 2025-12-26 23:58:09 +07:00
39 lines
1.3 KiB
TypeScript
39 lines
1.3 KiB
TypeScript
export interface CommandProperties {
|
|
[key: string]: any;
|
|
}
|
|
/**
|
|
* Issues a command to the GitHub Actions runner
|
|
*
|
|
* @param command - The command name to issue
|
|
* @param properties - Additional properties for the command (key-value pairs)
|
|
* @param message - The message to include with the command
|
|
* @remarks
|
|
* This function outputs a specially formatted string to stdout that the Actions
|
|
* runner interprets as a command. These commands can control workflow behavior,
|
|
* set outputs, create annotations, mask values, and more.
|
|
*
|
|
* Command Format:
|
|
* ::name key=value,key=value::message
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* // Issue a warning annotation
|
|
* issueCommand('warning', {}, 'This is a warning message');
|
|
* // Output: ::warning::This is a warning message
|
|
*
|
|
* // Set an environment variable
|
|
* issueCommand('set-env', { name: 'MY_VAR' }, 'some value');
|
|
* // Output: ::set-env name=MY_VAR::some value
|
|
*
|
|
* // Add a secret mask
|
|
* issueCommand('add-mask', {}, 'secretValue123');
|
|
* // Output: ::add-mask::secretValue123
|
|
* ```
|
|
*
|
|
* @internal
|
|
* This is an internal utility function that powers the public API functions
|
|
* such as setSecret, warning, error, and exportVariable.
|
|
*/
|
|
export declare function issueCommand(command: string, properties: CommandProperties, message: any): void;
|
|
export declare function issue(name: string, message?: string): void;
|