mirror of
https://github.com/dawidd6/action-send-mail.git
synced 2026-01-31 19:38:27 +07:00
afe9786629
* Initial plan * Run npm ci --ignore-scripts to update dependencies Co-authored-by: dawidd6 <9713907+dawidd6@users.noreply.github.com> * Convert CommonJS to ESM (#255) * Initial plan * Convert CommonJS imports to ESM Co-authored-by: dawidd6 <9713907+dawidd6@users.noreply.github.com> * Use node: protocol prefix for built-in modules Co-authored-by: dawidd6 <9713907+dawidd6@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: dawidd6 <9713907+dawidd6@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: dawidd6 <9713907+dawidd6@users.noreply.github.com>
91 lines
2.9 KiB
JavaScript
91 lines
2.9 KiB
JavaScript
import * as os from 'os';
|
|
import { toCommandValue } from './utils.js';
|
|
/**
|
|
* 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 function issueCommand(command, properties, message) {
|
|
const cmd = new Command(command, properties, message);
|
|
process.stdout.write(cmd.toString() + os.EOL);
|
|
}
|
|
export function issue(name, message = '') {
|
|
issueCommand(name, {}, message);
|
|
}
|
|
const CMD_STRING = '::';
|
|
class Command {
|
|
constructor(command, properties, message) {
|
|
if (!command) {
|
|
command = 'missing.command';
|
|
}
|
|
this.command = command;
|
|
this.properties = properties;
|
|
this.message = message;
|
|
}
|
|
toString() {
|
|
let cmdStr = CMD_STRING + this.command;
|
|
if (this.properties && Object.keys(this.properties).length > 0) {
|
|
cmdStr += ' ';
|
|
let first = true;
|
|
for (const key in this.properties) {
|
|
if (this.properties.hasOwnProperty(key)) {
|
|
const val = this.properties[key];
|
|
if (val) {
|
|
if (first) {
|
|
first = false;
|
|
}
|
|
else {
|
|
cmdStr += ',';
|
|
}
|
|
cmdStr += `${key}=${escapeProperty(val)}`;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
cmdStr += `${CMD_STRING}${escapeData(this.message)}`;
|
|
return cmdStr;
|
|
}
|
|
}
|
|
function escapeData(s) {
|
|
return toCommandValue(s)
|
|
.replace(/%/g, '%25')
|
|
.replace(/\r/g, '%0D')
|
|
.replace(/\n/g, '%0A');
|
|
}
|
|
function escapeProperty(s) {
|
|
return toCommandValue(s)
|
|
.replace(/%/g, '%25')
|
|
.replace(/\r/g, '%0D')
|
|
.replace(/\n/g, '%0A')
|
|
.replace(/:/g, '%3A')
|
|
.replace(/,/g, '%2C');
|
|
}
|
|
//# sourceMappingURL=command.js.map
|