actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-25 07:31:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update documentation about VALIDATE_[LANGUAGE] vars

Browse source
This commit is contained in:
Gabo 2020-08-11 21:16:36 -05:00
parent d05f179506
commit 13e50cc32e
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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. 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. _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 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. - 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. 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, 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.
and won't run anything unexpected.
| **ENV VAR** | **Default Value** | **Notes** | | **ENV VAR** | **Default Value** | **Notes** |
| -------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |