jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-09 15:02:41 -05:00
Code Issues Projects Releases Wiki Activity

Add documentation for "notice" command

Browse Source 
The core.notice toolkit command is documented, but the equivalent
workflow command was not covered on this page.
This commit is contained in:
Rob Cowsill
2021-09-07 16:08:53 +01:00
committed by GitHub
parent 6614dfb413
commit 3960ebf2f6
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
content/actions/reference/workflow-commands-for-github-actions.md
View File

@@ -77,6 +77,7 @@ The following table shows which toolkit functions are available within a workflo
| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` |
| `core.getState` | Accessible using environment variable `STATE_{NAME}` |
| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` |
| `core.notice` | `notice` |
| `core.saveState` | `save-state` |
| `core.setFailed` | Used as a shortcut for `::error` and `exit 1` |
| `core.setOutput` | `set-output` |
@@ -138,6 +139,18 @@ Prints a debug message to the log. You must create a secret named `ACTIONS_STEP_
echo "::debug::Set the Octocat variable"
```
## Setting a notice message
`::notice file={name},line={line},col={col}::{message}`
Creates a notice message and prints the message to the log. You can optionally provide a filename (`file`), line number (`line`), and column number (`col`) where the notice occurred. Line and column numbers start at 1.
### Example
``` bash
echo "::notice file=app.js,line=1,col=5::Spelling mistake in string"
```
## Setting a warning message
`::warning file={name},line={line},col={col}::{message}`