actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

Mention single quote limitation on documentation of exec.exec and exec.getExecOutput

pull/1383/head
Takumasa Ochi 2023-03-23 19:26:05 +09:00
parent 457303960f
commit 43e31091ee
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/exec/src/exec.ts
View File

@ -9,7 +9,7 @@ export {ExecOptions, ExecOutput, ExecListeners}
* Output will be streamed to the live console. * Output will be streamed to the live console.
* Returns promise with return code * Returns promise with return code
* *
* @param commandLine command to execute (can include additional args). Must be correctly escaped. * @param commandLine command to execute (can include additional args). Must be correctly escaped. Currently, only double quotes are supported for splitting args.
* @param args optional arguments for tool. Escaping is handled by the lib. * @param args optional arguments for tool. Escaping is handled by the lib.
* @param options optional exec options. See ExecOptions * @param options optional exec options. See ExecOptions
* @returns Promise<number> exit code * @returns Promise<number> exit code
@ -35,7 +35,7 @@ export async function exec(
* Output will be streamed to the live console. * Output will be streamed to the live console.
* Returns promise with the exit code and collected stdout and stderr * Returns promise with the exit code and collected stdout and stderr
* *
* @param commandLine command to execute (can include additional args). Must be correctly escaped. * @param commandLine command to execute (can include additional args). Must be correctly escaped. Currently, only double quotes are supported for splitting args.
* @param args optional arguments for tool. Escaping is handled by the lib. * @param args optional arguments for tool. Escaping is handled by the lib.
* @param options optional exec options. See ExecOptions * @param options optional exec options. See ExecOptions
* @returns Promise<ExecOutput> exit code, stdout, and stderr * @returns Promise<ExecOutput> exit code, stdout, and stderr