Update documentation

This commit is contained in:
Peter Evans
2020-07-22 14:51:10 +09:00
parent f04fe36a13
commit f59323b20a
2 changed files with 7 additions and 4 deletions
+3
View File
@@ -37,6 +37,9 @@ inputs:
description: 'JSON configuration for commands.'
config-from-file:
description: 'JSON configuration from a file for commands.'
outputs:
error-message:
description: 'Validation errors when using `workflow` dispatch.'
runs:
using: 'node12'
main: 'dist/index.js'
+4 -4
View File
@@ -91,14 +91,14 @@ The simplest response is to add a :tada: reaction to the comment.
reaction-type: hooray
```
### Action warnings
### Validation errors
When creating the [workflow_dispatch](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) event, the GitHub API will return validation errors. In the following cases the action will issue a warning (visible in the Actions log), and set the action output `error-message`.
- `Required input '...' not provided`: A required input for the workflow was not supplied as a named argument.
- `Unexpected inputs provided`: Named arguments were supplied that are not defined as workflow inputs.
- `Required input '...' not provided` - A required input for the workflow was not supplied as a named argument.
- `Unexpected inputs provided` - Named arguments were supplied that are not defined as workflow inputs.
The `error-message` output can be used to provide feedback to the user as follows. Note that the step needs an `id` to access the outputs.
The `error-message` output can be used to provide feedback to the user as follows. Note that the action step needs an `id` to access the outputs.
```yml
- name: Slash Command Dispatch