actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2025-01-11 00:41:27 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #92 from github/cleanupEnv

Browse source 
make the readme better
This commit is contained in:
Lukas Gravley 2020-05-14 09:04:01 -05:00 committed by GitHub
commit 92b74f65fd
WARNING! Although there is a key with this ID in the database it does not verify this commit! This commit is SUSPICIOUS.
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
README.md
View file

@ -100,69 +100,31 @@ jobs:
... ...
``` ```
## Env Vars ## Environment variables
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:
- **VALIDATE_ALL_CODEBASE**
- Default: `true` | **ENV VAR** | **Default Value** | **Notes** |
- Will parse the entire repository and find all files to validate across all types | --- | --- | --- |
- **NOTE:** When set to `false`, only **new** or **edited** files will be parsed for validation | **VALIDATE_ALL_CODEBASE** | `true` | Will parse the entire repository and find all files to validate across all types. **NOTE:** When set to `false`, only **new** or **edited** files will be parsed for validation. |
- **VALIDATE_YAML** | **VALIDATE_YAML** | `true` |Flag to enable or disable the linting process of the language. |
- Default: `true` | **VALIDATE_JSON** | `true` | Flag to enable or disable the linting process of the language. |
- Flag to enable or disable the linting process of the language | **VALIDATE_XML** | `true` | Flag to enable or disable the linting process of the language. |
- **VALIDATE_JSON** | **VALIDATE_MD** | `true` | Flag to enable or disable the linting process of the language. |
- Default: `true` | **VALIDATE_BASH** | `true` | Flag to enable or disable the linting process of the language. |
- Flag to enable or disable the linting process of the language | **VALIDATE_PERL** | `true` | Flag to enable or disable the linting process of the language. |
- **VALIDATE_XML** | **VALIDATE_PYTHON** | `true` | Flag to enable or disable the linting process of the language. |
- Default: `true` | **VALIDATE_RUBY** | `true` | Flag to enable or disable the linting process of the language. |
- Flag to enable or disable the linting process of the language | **VALIDATE_COFFEE** | `true` | Flag to enable or disable the linting process of the language . |
- **VALIDATE_MD** | **VALIDATE_ANSIBLE** | `true` | Flag to enable or disable the linting process of the language. |
- Default: `true` | **VALIDATE_JAVASCRIPT_ES** | `true` | Flag to enable or disable the linting process of the language. (Utilizing: eslint) |
- Flag to enable or disable the linting process of the language | **VALIDATE_JAVASCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the language. (Utilizing: standard) |
- **VALIDATE_BASH** | **VALIDATE_TYPESCRIPT_ES** | `true` | Flag to enable or disable the linting process of the language. (Utilizing: eslint) |
- Default: `true` | **VALIDATE_TYPESCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the language. (Utilizing: standard) |
- Flag to enable or disable the linting process of the language | **ANSIBLE_DIRECTORY** | `/ansible` | Flag to set the root directory for Ansible file location(s). |
- **VALIDATE_PERL** | **VALIDATE_DOCKER** | `true` | Flag to enable or disable the linting process of the language. |
- Default: `true` | **VALIDATE_GO** | `true` | Flag to enable or disable the linting process of the language. |
- Flag to enable or disable the linting process of the language | **VALIDATE_TERRAFORM** | `true` | Flag to enable or disable the linting process of the language. |
- **VALIDATE_PYTHON** | **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. |
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_RUBY**
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_COFFEE**
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_ANSIBLE**
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_JAVASCRIPT_ES**
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: eslint)
- **VALIDATE_JAVASCRIPT_STANDARD**
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: standard)
- **VALIDATE_TYPESCRIPT_ES**
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: eslint)
- **VALIDATE_TYPESCRIPT_STANDARD**
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: standard)
- **ANSIBLE_DIRECTORY**
- Default: `/ansible`
- Flag to set the root directory for Ansible file location(s)
- **VALIDATE_DOCKER**
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_GO**
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_TERRAFORM**
- Default: `true`
- Flag to enable or disable the linting process of the language
- **ACTIONS_RUNNER_DEBUG**
- Default: `false`
- Flag to enable additional information about the linter, versions, and additional output
### Template rules files ### Template rules files
You can use the **GitHub** **Super-Linter** *with* or *without* your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level. You can use the **GitHub** **Super-Linter** *with* or *without* your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level.