Skip to content

Commit 212f266

Browse files
Add warning field values
1 parent f5432d3 commit 212f266

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,17 @@ There is a `warnings` option to set how warnings are handled, and more options t
117117
|`warning-no-pins`|No pins found in definition file|
118118
|`warning-dupe`|More than one pin that share the same `pin` field in a single mapping|
119119

120+
Listed below are the possible values for these fields.
121+
122+
|value|behavior|
123+
|-----|-----|
124+
|false|Print warning|
125+
|notice|Print warning and put notice on workflow summary page|
126+
|error|Cause the workflow to fail immediately|
127+
|skip|Skip generating this pinout, but proceed with any other pinouts|
128+
129+
If a specific `warning-*` field is not set, the value from the `warnings` field is used. You can use this to set the default behavior for warnings, and override specific types of warnings with their own field.
130+
120131
### Example Workflow Step
121132

122133
For a real-life example, [see how rusEFI](https://github.com/rusefi/rusefi/blob/master/.github/workflows/gen-pinouts.yaml) uses interactive-pinouts in Github Actions.

0 commit comments

Comments
 (0)