Add docs and wrapper for "echo" command (#411)

* Add docs and wrapper for "echo" command

* Update parameter to enabled
This commit is contained in:
Thomas Boop
2020-04-13 13:25:54 -04:00
committed by GitHub
parent 3c125ce4e0
commit 05e39f551d
3 changed files with 43 additions and 1 deletions

View File

@@ -239,6 +239,16 @@ describe('@actions/core', () => {
process.env['RUNNER_DEBUG'] = current
}
})
it('setCommandEcho can enable echoing', () => {
core.setCommandEcho(true)
assertWriteCalls([`::echo::on${os.EOL}`])
})
it('setCommandEcho can disable echoing', () => {
core.setCommandEcho(false)
assertWriteCalls([`::echo::off${os.EOL}`])
})
})
// Assert that process.stdout.write calls called only with the given arguments.

View File

@@ -87,6 +87,15 @@ export function setOutput(name: string, value: any): void {
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
//-----------------------------------------------------------------------