Skip to content

Commit

Permalink
Add warning field values
Browse files Browse the repository at this point in the history
  • Loading branch information
chuckwagoncomputing authored Feb 22, 2024
1 parent f5432d3 commit 212f266
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,17 @@ There is a `warnings` option to set how warnings are handled, and more options t
|`warning-no-pins`|No pins found in definition file|
|`warning-dupe`|More than one pin that share the same `pin` field in a single mapping|

Listed below are the possible values for these fields.

|value|behavior|
|-----|-----|
|false|Print warning|
|notice|Print warning and put notice on workflow summary page|
|error|Cause the workflow to fail immediately|
|skip|Skip generating this pinout, but proceed with any other pinouts|

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.

### Example Workflow Step

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.
Expand Down

0 comments on commit 212f266

Please sign in to comment.