README.md

February 5, 2021 ยท View on GitHub

CmdletSynopsis
Add-ActionPathPrepends path to the PATH (for this action and future actions). Equivalent of core.addPath(path).
Add-ActionSecretRegisters a secret which will get masked from logs. Equivalent of core.setSecret(secret).
Enter-ActionOutputGroupBegin an output group. Output until the next groupEnd will be foldable in this group. Equivalent of core.startGroup(name).
Exit-ActionOutputGroupEnd an output group. Equivalent of core.endGroup().
Get-ActionInputGets the value of an input. The value is also trimmed. Equivalent of core.getInput(name).
Get-ActionIsDebugGets whether Actions Step Debug is on or not. Equivalent of core.isDebug().
Invoke-ActionGroupExecutes the argument script block within an output group. Equivalent of core.group(name, func).
Invoke-ActionNoCommandsBlockInvokes a scriptblock that won't result in any output interpreted as a workflow command. Useful for printing arbitrary text that may contain command-like text. No quivalent in @actions/core package.
Send-ActionCommandSends a command to the hosting Workflow/Action context. Equivalent to core.issue(cmd, msg)/core.issueCommand(cmd, props, msg).
Send-ActionFileCommandSends a command to an Action Environment File. Equivalent to core.issueFileCommand(cmd, msg).
Set-ActionCommandEchoEnables 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. Equivalent of core.setCommandEcho(enabled).
Set-ActionFailedSets an action status to failed. When the action exits it will be with an exit code of 1. Equivalent of core.setFailed(message).
Set-ActionOutputSets the value of an output. Equivalent of core.setOutput(name, value).
Set-ActionVariableSets env variable for this action and future actions in the job. Equivalent of core.exportVariable(name, value).
Write-ActionDebugWrites debug message to user log. Equivalent of core.debug(message).
Write-ActionErrorAdds an error issue. Equivalent of core.error(message).
Write-ActionInfoWrites info to log with console.log. Equivalent of core.info(message). Forwards to Write-Host.
Write-ActionWarningAdds a warning issue. Equivalent of core.warning(message).