actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-09-13 07:57:10 -04:00
Code Issues Projects Releases Packages Wiki Activity
superlint/TEMPLATES/README.md
Kurt von Laven 8227f79074
Add a template config file for ShellCheck (#1900) 
* Improve wording of LINTER_RULES_PATH docs (#1634).

* Add a template config file for ShellCheck (#1633).

Instruct ShellCheck to search SCRIPTDIR, the directory that the script
being linted is in, for other scripts that are sourced. Otherwise, the
commonly-used source command results in linter error SC1091. See
https://github.com/koalaman/shellcheck/wiki/SC1091 for more details.

* fix line ending

Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-08-30 11:19:56 -05:00

549 B
Raw Blame History

TEMPLATES

The files in this folder are template rules for the linters that will run against your code base. If you choose to copy these to your local repository in the .github/linters/ directory, they will be used at runtime. If rule files are not present locally, the templates will be used by default.

The file(s) will be parsed at run time on the local branch to load all rules needed to run the Super-Linter GitHub Action. The GitHub Action will inform the user via the Checks API on the status and success of the process.