Welcome to the GitHub Super-Linter wiki!

Tips and Tricks

Only linting new files

You may only want to lint new and modified files to keep from having an enormous list of files that need to be updated. The environment variable: VALIDATE_ALL_CODEBASE can be set to help change the default behavior from all files to only new and modified. Example:

      ################################
      # Run Linter against code base #
      ################################
      - name: Lint Code Base
        uses: docker://github/super-linter:v2.1.0
        env:
          VALIDATE_ALL_CODEBASE: false

Disabling Linters

You may find some default rules go against your standards and best practices. If you find a rule that you would like to commit, you can do one of the following actions:

• Disable the linter entirely
• Disable the file, block, or line of code

Disable linter entirely

You can disable the entire linter by passing the environment variable: VALIDATE_<LANGUAGE>. This information is laid out in the README - Env Vars Example:

      ################################
      # Run Linter against code base #
      ################################
      - name: Lint Code Base
        uses: docker://github/super-linter:v2.1.0
        env:
          VALIDATE_JSON: false

Disable file, block, or line of code

If you are looking to omit rules on a smaller scale, you can take advantage of the rules files, and inline updates. YOu can view the document Disabling Linters for a full explanation on how to disable each linter.