Merge pull request #9 from github/flags

Flags

Dockerfile

@@ -58,7 +58,18 @@ RUN wget -qO- "https://storage.googleapis.com/shellcheck/shellcheck-stable.linux
 ###########################################
 ENV GITHUB_SHA=${GITHUB_SHA} \
     GITHUB_EVENT_PATH=${GITHUB_EVENT_PATH} \
-    GITHUB_WORKSPACE=${GITHUB_WORKSPACE}
+    GITHUB_WORKSPACE=${GITHUB_WORKSPACE} \
+    VALIDATE_ALL_CODEBASE=${VALIDATE_ALL_CODEBASE} \
+    VALIDATE_YAML=${VALIDATE_YAML} \
+    VALIDATE_JSON=${VALIDATE_JSON} \
+    VALIDATE_XML=${VALIDATE_XML} \
+    VALIDATE_MD=${VALIDATE_MD} \
+    VALIDATE_BASH=${VALIDATE_BASH} \
+    VALIDATE_PERL=${VALIDATE_PERL} \
+    VALIDATE_PYTHON=${VALIDATE_PYTHON} \
+    VALIDATE_RUBY=${VALIDATE_RUBY} \
+    VALIDATE_COFFEE=${VALIDATE_COFFEE} \
+    VALIDATE_ANSIBLE=${VALIDATE_ANSIBLE}
 
 #############################
 # Copy scripts to container #
@@ -73,6 +84,6 @@ COPY TEMPLATES /action/lib/.automation
 ######################
 # Set the entrypoint #
 ######################
-ENTRYPOINT ["/action/lib/entrypoint.sh"]
+ENTRYPOINT ["/action/lib/linter.sh"]
 
 #CMD tail -f /dev/null

README.md

@@ -75,8 +75,47 @@ jobs:
       ################################
       - name: Lint Code Base
         uses: docker://admiralawkbar/super-linter:latest
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_ANSIBLE: false
 ...
 ```
+## Env Vars
+The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality:
+- **VALIDATE_ALL_CODEBASE**
+  - Default: `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**
+  - Default: `true`
+  - Flag to enable or disable the linting process of the language
+- **VALIDATE_JSON**
+  - Default: `true`
+  - Flag to enable or disable the linting process of the language
+- **VALIDATE_XML**
+  - Default: `true`
+  - Flag to enable or disable the linting process of the language
+- **VALIDATE_MD**
+  - Default: `true`
+  - Flag to enable or disable the linting process of the language
+- **VALIDATE_BASH**
+  - Default: `true`
+  - Flag to enable or disable the linting process of the language
+- **VALIDATE_PERL**
+  - Default: `true`
+  - Flag to enable or disable the linting process of the language
+- **VALIDATE_PYTHON**
+  - 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
 
 ## Docker Hub