From 212f266256a0293512a74dbce8a1ccad4fcfa21b Mon Sep 17 00:00:00 2001 From: David Holdeman Date: Thu, 22 Feb 2024 09:39:02 -0600 Subject: [PATCH] Add warning field values --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 6fae735..cebaaeb 100644 --- a/README.md +++ b/README.md @@ -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.