From 13e50cc32e88208137bc59c3a546e4e49211599d Mon Sep 17 00:00:00 2001 From: Gabo Date: Tue, 11 Aug 2020 21:16:36 -0500 Subject: [PATCH] Update documentation about VALIDATE_[LANGUAGE] vars --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 167b6f37..324a5aae 100644 --- a/README.md +++ b/README.md @@ -162,12 +162,14 @@ Using the line:`uses: docker://github/super-linter:v3` will pull the image down The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality. -_Note:_ All the `VALIDATE_[LANGUAGE]` variables behave in a specific way. -If none of them are passed, then they all default to true. -However if any one of the variables are set, we default to leaving any unset variable to false. +_Note:_ All the `VALIDATE_[LANGUAGE]` variables behave in a very specific way: +- If none of them are passed, then they all default to true. +- If any one of the variables are set to true, we default to leaving any unset variable to false (only validate those languages). +- If any one of the variables are set to false, we default to leaving any unset variable to true (only exclude those languages). +- If there are `VALIDATE_[LANGUAGE]` variables set to both true and false. It will fail. + This means that if you run the linter "out of the box", all languages will be checked. -But if you wish to select specific linters, we give you full control to choose which linters are run, -and won't run anything unexpected. +But if you wish to select or exclude specific linters, we give you full control to choose which linters are run, and won't run anything unexpected. | **ENV VAR** | **Default Value** | **Notes** | | -------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |