actions/toolkit
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/actions/toolkit synced 2026-05-04 01:18:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/commands.md
View File

@@ -122,7 +122,7 @@ echo "::save-state name=FOO::foovalue"
### Log Level
Finally, there are several commands to emit different levels of log output:
There are several commands to emit different levels of log output:
| log level | example usage |
|---|---|
@@ -130,6 +130,29 @@ Finally, there are several commands to emit different levels of log output:
| warning | `echo "::warning::My warning message"` |
| error | `echo "::error::My error message"` |
### Command Echoing
By default, the echoing of commands to stdout only occurs if [Step Debugging is enabled](./actions-debugging.md#How-to-Access-Step-Debug-Logs)
You can enable or disable this for the current step by using the `echo` command.
```bash
echo "::echo::on"
```
You can also disable echoing.
```bash
echo "::echo::off"
```
This is wrapped by the core method:
```javascript
function setCommandEcho(enabled: boolean): void {}
```
The `add-mask`, `debug`, `warning` and `error` commands do not support echoing.
### Command Prompt
CMD processes the `"` character differently from other shells when echoing. In CMD, the above snippets should have the `"` characters removed in order to correctly process. For example, the set output command would be:
```cmd