2019-10-21 10:12:50 -04:00
# Super-Linter
2020-07-21 13:08:05 -04:00
2023-12-22 07:22:15 -05:00
Super-linter is a ready-to-run collection of linters and code analyzers, to
2024-08-07 09:36:16 -04:00
help validate and fix your source code.
2023-12-11 16:35:20 -05:00
The goal of super-linter is to help you establish best practices and consistent
formatting across multiple programming languages, and ensure developers are
adhering to those conventions.
Super-linter analyzes source code files using several tools, and reports the
issues that those tools find as console output, and as
[GitHub Actions status checks ](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks ).
2023-12-16 03:30:33 -05:00
You can also [run super-linter outside GitHub Actions ](#run-super-linter-outside-github-actions ).
2023-12-11 16:35:20 -05:00
2024-08-07 09:36:16 -04:00
Super-linter can also help you [fix linting and formatting issues ](#fix-linting-and-formatting-issues ).
2024-08-06 11:03:25 -04:00
Super-linter is licensed under an
2023-12-11 16:35:20 -05:00
[MIT License ](https://github.com/super-linter/super-linter/blob/main/LICENSE ).
[](https://github.com/marketplace/actions/super-linter)
2024-02-12 13:20:53 -05:00
Here are some notable Super-linter features:
- **MIT License**: Super-linter is licensed under a [MIT License ](LICENSE ).
2024-02-17 06:12:06 -05:00
- **Independent project**: Super-linter is maintained by a team of independent
developers and is not commercially backed by any entity that might influence
2024-02-12 13:20:53 -05:00
the course of the project.
- **Widely used**: Super-linter is the
[most widely used ](https://github.com/super-linter/super-linter/network/dependents )
and [forked ](https://github.com/super-linter/super-linter/forks ) project of
this kind.
- **Runs linters in parallel**: Since `v6` , Super-linter parallelizes
running all the included linters, leading to scanning massive code
repositories in seconds.
- **Highly curated set of linters**: Avoid including linters that implement
overlapping checks, reducing bloat, scanning times, and container image size.
- **Run on GitHub Actions or other environments**: Super-linter runs
[on GitHub Actions ](#get-started ) and
[other runtime environments ](#run-using-a-container-runtime-engine ), with the
only dependency of an OCI-compatible container runtime engine, such as Docker.
- **Lean codebase**: Super-linter doesn't reinvent the wheel, and builds on top
of established tools and standards, such as
[GNU Parallel ](https://www.gnu.org/software/parallel/ ).
2024-08-06 11:03:25 -04:00
- **Extensive test suite**: Super-linter includes an extensive test suite that
2024-02-12 13:20:53 -05:00
covers every single linter and analyzer that Super-linter ships.
- **Original design**: to the best of our knowledge, Super-linter is the first
open-source, fully-containerized linting suite. Other projects borrow ideas
and design choices from Super-linter (and we're cool with that :).
2023-12-11 16:35:20 -05:00
## Supported linters and code analyzers
Super-linter supports the following tools:
2019-10-21 10:12:50 -04:00
2023-01-09 00:22:08 -05:00
| _Language_ | _Linter_ |
|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Ansible** | [ansible-lint ](https://github.com/ansible/ansible-lint ) |
| **AWS CloudFormation templates** | [cfn-lint ](https://github.com/aws-cloudformation/cfn-python-lint/ ) |
| **Azure Resource Manager (ARM)** | [arm-ttk ](https://github.com/azure/arm-ttk ) |
| **C++** | [cpp-lint ](https://github.com/cpplint/cpplint ) / [clang-format ](https://clang.llvm.org/docs/ClangFormatStyleOptions.html ) |
2023-10-16 14:31:03 -04:00
| **C#** | [dotnet format ](https://github.com/dotnet/format ) / [clang-format ](https://clang.llvm.org/docs/ClangFormatStyleOptions.html ) |
2023-01-09 00:22:08 -05:00
| **CSS** | [stylelint ](https://stylelint.io/ ) |
| **Clojure** | [clj-kondo ](https://github.com/borkdude/clj-kondo ) |
| **CoffeeScript** | [coffeelint ](https://coffeelint.github.io/ ) |
| **Copy/paste detection** | [jscpd ](https://github.com/kucherenko/jscpd ) |
| **Dart** | [dartanalyzer ](https://dart.dev/guides/language/analysis-options ) |
| **Dockerfile** | [hadolint ](https://github.com/hadolint/hadolint ) |
| **EditorConfig** | [editorconfig-checker ](https://github.com/editorconfig-checker/editorconfig-checker ) |
| **ENV** | [dotenv-linter ](https://github.com/dotenv-linter/dotenv-linter ) |
| **Gherkin** | [gherkin-lint ](https://github.com/vsiakka/gherkin-lint ) |
| **GitHub Actions** | [actionlint ](https://github.com/rhysd/actionlint ) |
| **Golang** | [golangci-lint ](https://github.com/golangci/golangci-lint ) |
2024-04-18 02:48:49 -04:00
| **GoReleaser** | [GoReleaser ](https://github.com/goreleaser/goreleaser ) |
2023-01-09 00:22:08 -05:00
| **Groovy** | [npm-groovy-lint ](https://github.com/nvuillam/npm-groovy-lint ) |
| **HTML** | [HTMLHint ](https://github.com/htmlhint/HTMLHint ) |
| **Java** | [checkstyle ](https://checkstyle.org ) / [google-java-format ](https://github.com/google/google-java-format ) |
| **JavaScript** | [ESLint ](https://eslint.org/ ) / [standard js ](https://standardjs.com/ ) |
| **JSON** | [eslint-plugin-json ](https://www.npmjs.com/package/eslint-plugin-json ) |
| **JSONC** | [eslint-plugin-jsonc ](https://www.npmjs.com/package/eslint-plugin-jsonc ) |
2023-12-22 07:22:15 -05:00
| Infrastructure as code | [Checkov ](https://www.checkov.io/ ) |
2023-01-09 00:22:08 -05:00
| **Kubernetes** | [kubeconform ](https://github.com/yannh/kubeconform ) |
| **Kotlin** | [ktlint ](https://github.com/pinterest/ktlint ) |
| **LaTeX** | [ChkTex ](https://www.nongnu.org/chktex/ ) |
| **Lua** | [luacheck ](https://github.com/luarocks/luacheck ) |
| **Markdown** | [markdownlint ](https://github.com/igorshubovych/markdownlint-cli#readme ) |
| **Natural language** | [textlint ](https://textlint.github.io/ ) |
| **OpenAPI** | [spectral ](https://github.com/stoplightio/spectral ) |
| **Perl** | [perlcritic ](https://metacpan.org/pod/Perl::Critic ) |
2023-12-11 12:37:24 -05:00
| **PHP** | [PHP built-in linter ](https://www.php.net/manual/en/features.commandline.options.php ) / [PHP CodeSniffer ](https://github.com/PHPCSStandards/PHP_CodeSniffer ) / [PHPStan ](https://phpstan.org/ ) / [Psalm ](https://psalm.dev/ ) |
2023-01-09 00:22:08 -05:00
| **PowerShell** | [PSScriptAnalyzer ](https://github.com/PowerShell/Psscriptanalyzer ) |
| **Protocol Buffers** | [protolint ](https://github.com/yoheimuta/protolint ) |
2024-04-10 08:02:28 -04:00
| **Python3** | [pylint ](https://pylint.pycqa.org/ ) / [flake8 ](https://flake8.pycqa.org/en/latest/ ) / [black ](https://github.com/psf/black ) / [isort ](https://pypi.org/project/isort/ ) / [ruff ](https://github.com/astral-sh/ruff ) |
2023-01-09 00:22:08 -05:00
| **R** | [lintr ](https://github.com/jimhester/lintr ) |
| **Raku** | [Raku ](https://raku.org ) |
2023-09-12 12:58:09 -04:00
| **Renovate** | [renovate-config-validator ](https://docs.renovatebot.com/config-validation/ ) |
2023-01-09 00:22:08 -05:00
| **Ruby** | [RuboCop ](https://github.com/rubocop-hq/rubocop ) |
| **Rust** | [Rustfmt ](https://github.com/rust-lang/rustfmt ) / [Clippy ](https://github.com/rust-lang/rust-clippy ) |
| **Scala** | [scalafmt ](https://github.com/scalameta/scalafmt ) |
| **Secrets** | [GitLeaks ](https://github.com/zricethezav/gitleaks ) |
| **Shell** | [ShellCheck ](https://github.com/koalaman/shellcheck ) / `executable bit check` / [shfmt ](https://github.com/mvdan/sh ) |
| **Snakemake** | [snakefmt ](https://github.com/snakemake/snakefmt/ ) / [snakemake --lint ](https://snakemake.readthedocs.io/en/stable/snakefiles/writing_snakefiles.html#best-practices ) |
| **SQL** | [sql-lint ](https://github.com/joereynolds/sql-lint ) / [sqlfluff ](https://github.com/sqlfluff/sqlfluff ) |
| **Tekton** | [tekton-lint ](https://github.com/IBM/tekton-lint ) |
| **Terraform** | [fmt ](https://developer.hashicorp.com/terraform/cli/commands/fmt ) / [tflint ](https://github.com/terraform-linters/tflint ) / [terrascan ](https://github.com/accurics/terrascan ) |
| **Terragrunt** | [terragrunt ](https://github.com/gruntwork-io/terragrunt ) |
| **TypeScript** | [ESLint ](https://eslint.org/ ) / [standard js ](https://standardjs.com/ ) |
| **XML** | [LibXML ](http://xmlsoft.org/ ) |
| **YAML** | [YamlLint ](https://github.com/adrienverge/yamllint ) |
2019-10-21 10:12:50 -04:00
2023-12-11 16:35:20 -05:00
## Get started
2020-07-21 13:08:05 -04:00
2020-07-01 12:38:15 -04:00
More in-depth [tutorial ](https://www.youtube.com/watch?v=EDAmFKO4Zt0&t=118s ) available
2020-06-30 19:45:08 -04:00
2023-12-11 16:35:20 -05:00
To run super-linter as a GitHub Action, you do the following:
2020-01-09 10:48:46 -05:00
2023-12-11 16:35:20 -05:00
1. Create a new [GitHub Actions workflow ](https://docs.github.com/en/actions/using-workflows/about-workflows#about-workflows ) in your repository with the following content:
2020-09-10 03:48:11 -04:00
2023-12-12 13:53:48 -05:00
```yaml
---
name: Lint
on: # yamllint disable-line rule:truthy
push: null
pull_request: null
2024-04-09 03:35:23 -04:00
permissions: { }
2023-12-12 13:53:48 -05:00
jobs:
build:
name: Lint
runs-on: ubuntu-latest
permissions:
contents: read
packages: read
# To report GitHub Actions status checks
statuses: write
steps:
- name: Checkout code
uses: actions/checkout@v4
2024-01-04 16:54:47 -05:00
with:
# super-linter needs the full git history to get the
# list of files that changed across commits
fetch-depth: 0
2023-12-12 13:53:48 -05:00
- name: Super-linter
2024-07-31 05:25:28 -04:00
uses: super-linter/super-linter@v6.8.0 # x-release-please-version
2023-12-12 13:53:48 -05:00
env:
# To report GitHub Actions status checks
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
...
```
2021-05-25 11:14:43 -04:00
2023-12-11 16:35:20 -05:00
1. Commit that file to a new branch.
1. Push the new commit to the remote repository.
1. Create a new pull request to observe the results.
2021-12-08 10:53:05 -05:00
2023-12-24 11:56:15 -05:00
## Upgrade to newer super-linter versions
For more information about upgrading super-linter to a new major version, see
the [upgrade guide ](docs/upgrade-guide.md ).
2024-07-04 16:23:47 -04:00
## Add Super-Linter badge in your repository readme
2021-05-25 11:14:43 -04:00
2024-07-04 16:23:47 -04:00
You can show Super-Linter status with a badge in your repository readme:
2021-05-25 11:14:43 -04:00
2023-12-11 16:35:20 -05:00
Example:
2021-06-15 13:11:45 -04:00
2023-12-11 16:35:20 -05:00
```markdown
[](https://github.com/marketplace/actions/super-linter)
2021-05-25 11:14:43 -04:00
```
2023-12-11 16:35:20 -05:00
For more information, see
[Adding a workflow status badge ](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge ).
2021-05-25 11:14:43 -04:00
2023-12-11 16:35:20 -05:00
## Super-linter variants
2021-06-15 13:11:45 -04:00
2023-12-11 16:35:20 -05:00
Super-Linter provides several variants:
2021-06-15 13:11:45 -04:00
2024-01-02 13:32:45 -05:00
- `standard` : `super-linter/super-linter@[VERSION]` : includes all supported linters.
- `slim` : `super-linter/super-linter/slim@[VERSION]` : includes all supported linters except:
2021-06-15 13:11:45 -04:00
2023-12-11 16:35:20 -05:00
- `rust` linters
- `armttk` linters
- `pwsh` linters
- `c#` linters
2020-06-12 18:10:18 -04:00
2024-08-07 09:36:16 -04:00
## Configure Super-linter
2020-09-05 06:43:30 -04:00
2024-08-07 09:36:16 -04:00
You can configure Super-linter using the following environment variables:
2020-08-11 22:16:36 -04:00
2023-12-11 16:35:20 -05:00
| **Environment variable** | **Default Value** | **Description** |
2023-09-29 16:25:37 -04:00
|-------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2023-10-26 20:56:55 -04:00
| **ANSIBLE_CONFIG_FILE** | `.ansible-lint.yml` | Filename for [Ansible-lint configuration ](https://ansible.readthedocs.io/projects/lint/configuring/ ) (ex: `.ansible-lint` , `.ansible-lint.yml` ) |
2023-09-29 16:25:37 -04:00
| **ANSIBLE_DIRECTORY** | `/ansible` | Flag to set the root directory for Ansible file location(s), relative to `DEFAULT_WORKSPACE` . Set to `.` to use the top-level of the `DEFAULT_WORKSPACE` . |
2024-04-25 15:47:55 -04:00
| **BASH_EXEC_IGNORE_LIBRARIES** | `false` | If set to `true` , shell files with a file extension and no shebang line are ignored when checking if the executable bit is set. |
| **BASH_FILE_NAME** | `.shellcheckrc` | Filename for [Shellcheck ](https://github.com/koalaman/shellcheck/blob/master/shellcheck.1.md#rc-files ) |
2024-07-31 09:29:55 -04:00
| **BASH_SEVERITY** | Shellcheck default severity | Specify the minimum severity of errors to consider in shellcheck. Valid values in order of severity are error, warning, info and style. |
2023-12-22 07:22:15 -05:00
| **CHECKOV_FILE_NAME** | `.checkov.yaml` | Configuration filename for Checkov. |
2024-04-25 15:47:55 -04:00
| **CLANG_FORMAT_FILE_NAME** | `.clang-format` | Configuration filename for [clang-format ](https://clang.llvm.org/docs/ClangFormatStyleOptions.html ). |
2023-12-05 03:04:13 -05:00
| **CREATE_LOG_FILE** | `false` | If set to `true` , it creates the log file. You can set the log filename using the `LOG_FILE` environment variable. This overrides any existing log files. |
2023-09-29 16:25:37 -04:00
| **CSS_FILE_NAME** | `.stylelintrc.json` | Filename for [Stylelint configuration ](https://github.com/stylelint/stylelint ) (ex: `.stylelintrc.yml` , `.stylelintrc.yaml` ) |
2024-02-08 03:41:07 -05:00
| **DEFAULT_BRANCH** | Default repository branch when running on GitHub Actions, `master` otherwise | The name of the repository default branch. There's no need to configure this variable when running on GitHub Actions |
| **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. Defaults to `GITHUB_WORKSPACE` when running in GitHub Actions. There's no need to configure this variable when running on GitHub Actions. |
2023-09-29 16:25:37 -04:00
| **DISABLE_ERRORS** | `false` | Flag to have the linter complete with exit code 0 even if errors were detected. |
| **DOCKERFILE_HADOLINT_FILE_NAME** | `.hadolint.yaml` | Filename for [hadolint configuration ](https://github.com/hadolint/hadolint ) (ex: `.hadolintlintrc.yaml` ) |
| **EDITORCONFIG_FILE_NAME** | `.ecrc` | Filename for [editorconfig-checker configuration ](https://github.com/editorconfig-checker/editorconfig-checker ) |
2023-12-12 14:57:15 -05:00
| **ENABLE_GITHUB_ACTIONS_GROUP_TITLE** | `false` if `RUN_LOCAL=true` , `true` otherwise | Flag to enable [GitHub Actions log grouping ](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines ). |
2024-07-28 15:34:40 -04:00
| **ENABLE_GITHUB_ACTIONS_STEP_SUMMARY** | `false` if `RUN_LOCAL=true` , `true` otherwise | Flag to enable [GitHub Actions job summary ](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary ) for the Super-linter action. For more information, see [Summary outputs ](#summary-outputs ). |
2024-02-20 14:05:39 -05:00
| **FILTER_REGEX_EXCLUDE** | not set | Regular expression defining which files will be excluded from linting (ex: `.*src/test.*` ). Not setting this variable means to process all files. |
| **FILTER_REGEX_INCLUDE** | not set | Regular expression defining which files will be processed by linters (ex: `.*src/.*` ). Not setting this variable means to process all files. `FILTER_REGEX_INCLUDE` is evaluated before `FILTER_REGEX_EXCLUDE` . |
2024-08-07 09:36:16 -04:00
| **FIX_ANSIBLE** | `false` | Option to enable fix mode for `ANSIBLE` . |
| **FIX_CLANG_FORMAT** | `false` | Option to enable fix mode for `CLANG_FORMAT` . |
| **FIX_CSHARP** | `false` | Option to enable fix mode for `CSHARP` . |
| **FIX_CSS** | `false` | Option to enable fix mode for `CSS` . |
| **FIX_ENV** | `false` | Option to enable fix mode for `ENV` . |
| **FIX_GO** | `false` | Option to enable fix mode for `GO` . |
| **FIX_GO_MODULES** | `false` | Option to enable fix mode for `GO_MODULES` . |
| **FIX_GOOGLE_JAVA_FORMAT** | `false` | Option to enable fix mode for `GOOGLE_JAVA_FORMAT` . |
| **FIX_GROOVY** | `false` | Option to enable fix mode for `GROOVY` . |
| **FIX_JAVASCRIPT_ES** | `false` | Option to enable fix mode for `JAVASCRIPT_ES` . |
| **FIX_JAVASCRIPT_PRETTIER** | `false` | Option to enable fix mode for `JAVASCRIPT_PRETTIER` . |
| **FIX_JAVASCRIPT_STANDARD** | `false` | Option to enable fix mode for `JAVASCRIPT_STANDARD` . |
| **FIX_JSON** | `false` | Option to enable fix mode for `JSON` . |
| **FIX_JSONC** | `false` | Option to enable fix mode for `JSONC` . |
| **FIX_JSX** | `false` | Option to enable fix mode for `JSX` . |
| **FIX_MARKDOWN** | `false` | Option to enable fix mode for `MARKDOWN` . |
| **FIX_POWERSHELL** | `false` | Option to enable fix mode for `POWERSHELL` . |
| **FIX_PROTOBUF** | `false` | Option to enable fix mode for `PROTOBUF` . |
| **FIX_PYTHON_BLACK** | `false` | Option to enable fix mode for `PYTHON_BLACK` . |
| **FIX_PYTHON_ISORT** | `false` | Option to enable fix mode for `PYTHON_ISORT` . |
| **FIX_PYTHON_RUFF** | `false` | Option to enable fix mode for `PYTHON_RUFF` . |
| **FIX_RUBY** | `false` | Option to enable fix mode for `RUBY` . |
| **FIX_RUST_2015** | `false` | Option to enable fix mode for `RUST_2015` . |
| **FIX_RUST_2018** | `false` | Option to enable fix mode for `RUST_2018` . |
| **FIX_RUST_2021** | `false` | Option to enable fix mode for `RUST_2021` . |
| **FIX_RUST_CLIPPY** | `false` | Option to enable fix mode for `RUST_CLIPPY` . |
| **FIX_SCALAFMT** | `false` | Option to enable fix mode for `SCALAFMT` . |
| **FIX_SHELL_SHFMT** | `false` | Option to enable fix mode for `SHELL_SHFMT` . |
| **FIX_SNAKEMAKE_SNAKEFMT** | `false` | Option to enable fix mode for `SNAKEMAKE_SNAKEFMT` . |
| **FIX_SQLFLUFF** | `false` | Option to enable fix mode for `SQLFLUFF` . |
| **FIX_TERRAFORM_FMT** | `false` | Option to enable fix mode for `TERRAFORM_FMT` . |
| **FIX_TSX** | `false` | Option to enable fix mode for `TSX` . |
| **FIX_TYPESCRIPT_ES** | `false` | Option to enable fix mode for `TYPESCRIPT_ES` . |
| **FIX_TYPESCRIPT_PRETTIER** | `false` | Option to enable fix mode for `TYPESCRIPT_PRETTIER` . |
| **FIX_TYPESCRIPT_STANDARD** | `false` | Option to enable fix mode for `TYPESCRIPT_STANDARD` . |
2023-09-29 16:25:37 -04:00
| **GITHUB_ACTIONS_CONFIG_FILE** | `actionlint.yml` | Filename for [Actionlint configuration ](https://github.com/rhysd/actionlint/blob/main/docs/config.md ) (ex: `actionlint.yml` ) |
| **GITHUB_ACTIONS_COMMAND_ARGS** | `null` | Additional arguments passed to `actionlint` command. Useful to [ignore some errors ](https://github.com/rhysd/actionlint/blob/main/docs/usage.md#ignore-some-errors ) |
2024-02-09 13:45:44 -05:00
| **GITHUB_CUSTOM_API_URL** | `https://api.${GITHUB_DOMAIN}` | Specify a custom GitHub API URL in case GitHub Enterprise is used: e.g. `https://github.myenterprise.com/api/v3` |
2024-06-21 02:54:19 -04:00
| **GITHUB_CUSTOM_SERVER_URL** | `https://${GITHUB_DOMAIN}"` | Specify a custom GitHub server URL. Useful for GitHub Enterprise instances. |
| **GITHUB_DOMAIN** | `github.com` | Specify a custom GitHub domain in case GitHub Enterprise is used: e.g. `github.myenterprise.com` . `GITHUB_DOMAIN` is a convenience configuration variable to automatically build `GITHUB_CUSTOM_API_URL` and `GITHUB_CUSTOM_SERVER_URL` . |
2023-09-29 16:25:37 -04:00
| **GITLEAKS_CONFIG_FILE** | `.gitleaks.toml` | Filename for [GitLeaks configuration ](https://github.com/zricethezav/gitleaks#configuration ) (ex: `.gitleaks.toml` ) |
| **IGNORE_GENERATED_FILES** | `false` | If set to `true` , super-linter will ignore all the files with `@generated` marker but without `@not-generated` marker. |
| **IGNORE_GITIGNORED_FILES** | `false` | If set to `true` , super-linter will ignore all the files that are ignored by Git. |
2024-01-02 12:47:45 -05:00
| **JAVA_FILE_NAME** | `sun_checks.xml` | Filename for [Checkstyle configuration ](https://checkstyle.sourceforge.io/config.html ). Checkstyle embeds several configuration files, such as `sun_checks.xml` , `google_checks.xml` that you can use without providing your own configuration file. |
2023-09-29 16:25:37 -04:00
| **JAVASCRIPT_ES_CONFIG_FILE** | `.eslintrc.yml` | Filename for [ESLint configuration ](https://eslint.org/docs/user-guide/configuring#configuration-file-formats ) (ex: `.eslintrc.yml` , `.eslintrc.json` ) |
| **JSCPD_CONFIG_FILE** | `.jscpd.json` | Filename for JSCPD configuration |
| **KUBERNETES_KUBECONFORM_OPTIONS** | `null` | Additional arguments to pass to the command-line when running **Kubernetes Kubeconform** (Example: --ignore-missing-schemas) |
| **LINTER_RULES_PATH** | `.github/linters` | Directory for all linter configuration rules. |
2024-07-28 15:34:40 -04:00
| **LOG_FILE** | `super-linter.log` | The filename for outputting logs. Super-linter saves the log file to `${DEFAULT_WORKSPACE}/${LOG_FILE}` . |
2024-02-09 13:43:58 -05:00
| **LOG_LEVEL** | `INFO` | How much output the script will generate to the console. One of `ERROR` , `WARN` , `NOTICE` , `INFO` , or `DEBUG` . |
2023-09-29 16:25:37 -04:00
| **MARKDOWN_CONFIG_FILE** | `.markdown-lint.yml` | Filename for [Markdownlint configuration ](https://github.com/DavidAnson/markdownlint#optionsconfig ) (ex: `.markdown-lint.yml` , `.markdownlint.json` , `.markdownlint.yaml` ) |
2024-07-31 09:29:55 -04:00
| **MARKDOWN_CUSTOM_RULE_GLOBS** | not set | Comma-separated list of [file globs ](https://github.com/igorshubovych/markdownlint-cli#globbing ) matching [custom Markdownlint rule files ](https://github.com/DavidAnson/markdownlint/blob/main/doc/CustomRules.md ). |
2023-09-29 16:25:37 -04:00
| **MULTI_STATUS** | `true` | A status API is made for each language that is linted to make visual parsing easier. |
| **NATURAL_LANGUAGE_CONFIG_FILE** | `.textlintrc` | Filename for [textlint configuration ](https://textlint.github.io/docs/getting-started.html#configuration ) (ex: `.textlintrc` ) |
| **PERL_PERLCRITIC_OPTIONS** | `null` | Additional arguments to pass to the command-line when running **perlcritic** (Example: --theme community) |
2024-07-28 15:34:40 -04:00
| **POWERSHELL_CONFIG_FILE** | `.powershell-psscriptanalyzer.psd1` | Filename for [PSScriptAnalyzer configuration ](https://learn.microsoft.com/en-gb/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer ) |
2023-09-29 16:25:37 -04:00
| **PHP_CONFIG_FILE** | `php.ini` | Filename for [PHP Configuration ](https://www.php.net/manual/en/configuration.file.php ) (ex: `php.ini` ) |
2023-12-11 16:35:20 -05:00
| **PHP_PHPCS_FILE_NAME** | `phpcs.xml` | Filename for [PHP CodeSniffer ](https://github.com/squizlabs/PHP_CodeSniffer ) (ex: `.phpcs.xml` , `.phpcs.xml.dist` ) |
2024-07-30 10:27:25 -04:00
| **PHP_PHPSTAN_CONFIG_FILE** | `phpstan.neon` | Filename for [PHPStan Configuration ](https://phpstan.org/config-reference ) (ex: `phpstan.neon` ) |
2023-09-29 16:25:37 -04:00
| **PROTOBUF_CONFIG_FILE** | `.protolintrc.yml` | Filename for [protolint configuration ](https://github.com/yoheimuta/protolint/blob/master/_example/config/.protolint.yaml ) (ex: `.protolintrc.yml` ) |
| **PYTHON_BLACK_CONFIG_FILE** | `.python-black` | Filename for [black configuration ](https://github.com/psf/black/blob/main/docs/guides/using_black_with_other_tools.md#black-compatible-configurations ) (ex: `.isort.cfg` , `pyproject.toml` ) |
| **PYTHON_FLAKE8_CONFIG_FILE** | `.flake8` | Filename for [flake8 configuration ](https://flake8.pycqa.org/en/latest/user/configuration.html ) (ex: `.flake8` , `tox.ini` ) |
| **PYTHON_ISORT_CONFIG_FILE** | `.isort.cfg` | Filename for [isort configuration ](https://pycqa.github.io/isort/docs/configuration/config_files.html ) (ex: `.isort.cfg` , `pyproject.toml` ) |
| **PYTHON_MYPY_CONFIG_FILE** | `.mypy.ini` | Filename for [mypy configuration ](https://mypy.readthedocs.io/en/stable/config_file.html ) (ex: `.mypy.ini` , `setup.config` ) |
| **PYTHON_PYLINT_CONFIG_FILE** | `.python-lint` | Filename for [pylint configuration ](https://pylint.pycqa.org/en/latest/user_guide/run.html?highlight=rcfile#command-line-options ) (ex: `.python-lint` , `.pylintrc` ) |
2024-04-25 15:47:55 -04:00
| **PYTHON_RUFF_CONFIG_FILE** | `.ruff.toml` | Filename for [ruff configuration ](https://docs.astral.sh/ruff/configuration/ ) |
2023-12-22 07:22:15 -05:00
| **RENOVATE_SHAREABLE_CONFIG_PRESET_FILE_NAMES** | not set | Comma-separated filenames for [renovate shareable config preset ](https://docs.renovatebot.com/config-presets/ ) (ex: `default.json` ) |
2023-09-29 16:25:37 -04:00
| **RUBY_CONFIG_FILE** | `.ruby-lint.yml` | Filename for [rubocop configuration ](https://docs.rubocop.org/rubocop/configuration.html ) (ex: `.ruby-lint.yml` , `.rubocop.yml` ) |
2024-07-28 15:34:40 -04:00
| **SAVE_SUPER_LINTER_OUTPUT** | `false` | If set to `true` , Super-linter will save its output in the workspace. For more information, see [Super-linter outputs ](#super-linter-outputs ). |
| **SAVE_SUPER_LINTER_SUMMARY** | `false` | If set to `true` , Super-linter will save a summary. For more information, see [Summary outputs ](#summary-outputs ). |
2023-09-29 16:25:37 -04:00
| **SCALAFMT_CONFIG_FILE** | `.scalafmt.conf` | Filename for [scalafmt configuration ](https://scalameta.org/scalafmt/docs/configuration.html ) (ex: `.scalafmt.conf` ) |
| **SNAKEMAKE_SNAKEFMT_CONFIG_FILE** | `.snakefmt.toml` | Filename for [Snakemake configuration ](https://github.com/snakemake/snakefmt#configuration ) (ex: `pyproject.toml` , `.snakefmt.toml` ) |
| **SSL_CERT_SECRET** | `none` | SSL cert to add to the **Super-Linter** trust store. This is needed for users on `self-hosted` runners or need to inject the cert for security standards (ex. ${{ secrets.SSL_CERT }}) |
| **SSH_KEY** | `none` | SSH key that has access to your private repositories |
| **SSH_SETUP_GITHUB** | `false` | If set to `true` , adds the `github.com` SSH key to `known_hosts` . This is ignored if `SSH_KEY` is provided - i.e. the `github.com` SSH key is always added if `SSH_KEY` is provided |
| **SSH_INSECURE_NO_VERIFY_GITHUB_KEY** | `false` | **INSECURE -** If set to `true` , does not verify the fingerprint of the github.com SSH key before adding this. This is not recommended! |
| **SQL_CONFIG_FILE** | `.sql-config.json` | Filename for [SQL-Lint configuration ](https://sql-lint.readthedocs.io/en/latest/files/configuration.html ) (ex: `sql-config.json` , `.config.json` ) |
| **SQLFLUFF_CONFIG_FILE** | `/.sqlfluff` | Filename for [SQLFLUFF configuration ](https://docs.sqlfluff.com/en/stable/configuration.html ) (ex: `/.sqlfluff` , `pyproject.toml` ) |
2024-07-01 08:50:52 -04:00
| **SUPER_LINTER_OUTPUT_DIRECTORY_NAME** | `super-linter-output` | Name of the directory where super-linter saves its output. |
2024-07-28 15:34:40 -04:00
| **SUPER_LINTER_SUMMARY_FILE_NAME** | `super-linter-summary.md` | Name of the file where to save the summary output. For more information, see [Summary outputs ](#summary-outputs ). |
2023-09-29 16:25:37 -04:00
| **SUPPRESS_FILE_TYPE_WARN** | `false` | If set to `true` , will hide warning messages about files without their proper extensions. Default is `false` |
| **SUPPRESS_POSSUM** | `false` | If set to `true` , will hide the ASCII possum at top of log output. Default is `false` |
| **TERRAFORM_TERRASCAN_CONFIG_FILE** | `terrascan.toml` | Filename for [terrascan configuration ](https://github.com/accurics/terrascan ) (ex: `terrascan.toml` ) |
| **TERRAFORM_TFLINT_CONFIG_FILE** | `.tflint.hcl` | Filename for [tfLint configuration ](https://github.com/terraform-linters/tflint ) (ex: `.tflint.hcl` ) |
| **TYPESCRIPT_ES_CONFIG_FILE** | `.eslintrc.yml` | Filename for [ESLint configuration ](https://eslint.org/docs/user-guide/configuring#configuration-file-formats ) (ex: `.eslintrc.yml` , `.eslintrc.json` ) |
2023-12-02 03:35:41 -05:00
| **TYPESCRIPT_STANDARD_TSCONFIG_FILE** | `${DEFAULT_WORKSPACE}/tsconfig.json` | Path to the [TypeScript project configuration ](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html ) in [ts-standard ](https://github.com/standard/ts-standard ). The path is relative to `DEFAULT_WORKSPACE` |
2023-09-29 16:25:37 -04:00
| **USE_FIND_ALGORITHM** | `false` | By default, we use `git diff` to find all files in the workspace and what has been updated, this would enable the Linux `find` method instead to find all files to lint |
| **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_ANSIBLE** | `true` | Flag to enable or disable the linting process of the Ansible language. |
| **VALIDATE_ARM** | `true` | Flag to enable or disable the linting process of the ARM language. |
| **VALIDATE_BASH** | `true` | Flag to enable or disable the linting process of the Bash language. |
| **VALIDATE_BASH_EXEC** | `true` | Flag to enable or disable the linting process of the Bash language to validate if file is stored as executable. |
| **VALIDATE_CPP** | `true` | Flag to enable or disable the linting process of the C++ language. |
2023-12-22 07:22:15 -05:00
| **VALIDATE_CHECKOV** | `true` | Flag to enable or disable the linting process with Checkov |
2023-09-29 16:25:37 -04:00
| **VALIDATE_CLANG_FORMAT** | `true` | Flag to enable or disable the linting process of the C++/C language with clang-format. |
| **VALIDATE_CLOJURE** | `true` | Flag to enable or disable the linting process of the Clojure language. |
| **VALIDATE_CLOUDFORMATION** | `true` | Flag to enable or disable the linting process of the AWS Cloud Formation language. |
2024-07-04 16:23:47 -04:00
| **VALIDATE_COFFEESCRIPT** | `true` | Flag to enable or disable the linting process of the CoffeeScript language. |
2023-09-29 16:25:37 -04:00
| **VALIDATE_CSHARP** | `true` | Flag to enable or disable the linting process of the C# language. |
| **VALIDATE_CSS** | `true` | Flag to enable or disable the linting process of the CSS language. |
| **VALIDATE_DART** | `true` | Flag to enable or disable the linting process of the Dart language. |
| **VALIDATE_DOCKERFILE_HADOLINT** | `true` | Flag to enable or disable the linting process of the Docker language. |
| **VALIDATE_EDITORCONFIG** | `true` | Flag to enable or disable the linting process with the EditorConfig. |
| **VALIDATE_ENV** | `true` | Flag to enable or disable the linting process of the ENV language. |
| **VALIDATE_GHERKIN** | `true` | Flag to enable or disable the linting process of the Gherkin language. |
| **VALIDATE_GITHUB_ACTIONS** | `true` | Flag to enable or disable the linting process of the GitHub Actions. |
| **VALIDATE_GITLEAKS** | `true` | Flag to enable or disable the linting process of the secrets. |
2023-12-16 03:30:33 -05:00
| **VALIDATE_GO** | `true` | Flag to enable or disable the linting process of the individual Golang files. Set this to `false` if you want to lint Go modules. See the `VALIDATE_GO_MODULES` variable. |
| **VALIDATE_GO_MODULES** | `true` | Flag to enable or disable the linting process of Go modules. Super-linter considers a directory to be a Go module if it contains a file named `go.mod` . |
2024-04-15 08:38:25 -04:00
| **VALIDATE_GO_RELEASER** | `true` | Flag to enable or disable the linting process of the GoReleaser config file. |
2023-09-29 16:25:37 -04:00
| **VALIDATE_GOOGLE_JAVA_FORMAT** | `true` | Flag to enable or disable the linting process of the Java language. (Utilizing: google-java-format) |
| **VALIDATE_GROOVY** | `true` | Flag to enable or disable the linting process of the language. |
| **VALIDATE_HTML** | `true` | Flag to enable or disable the linting process of the HTML language. |
| **VALIDATE_JAVA** | `true` | Flag to enable or disable the linting process of the Java language. (Utilizing: checkstyle) |
| **VALIDATE_JAVASCRIPT_ES** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: ESLint) |
2024-07-19 01:04:43 -04:00
| **VALIDATE_JAVASCRIPT_PRETTIER** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: prettier) |
2023-09-29 16:25:37 -04:00
| **VALIDATE_JAVASCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: standard) |
2024-07-04 05:13:51 -04:00
| **VALIDATE_JSCPD** | `true` | Flag to enable or disable JSCPD. |
2023-09-29 16:25:37 -04:00
| **VALIDATE_JSON** | `true` | Flag to enable or disable the linting process of the JSON language. |
2024-07-04 05:13:51 -04:00
| **VALIDATE_JSONC** | `true` | Flag to enable or disable the linting process of the JSONC and JSON5 languages. |
2023-09-29 16:25:37 -04:00
| **VALIDATE_JSX** | `true` | Flag to enable or disable the linting process for jsx files (Utilizing: ESLint) |
| **VALIDATE_KOTLIN** | `true` | Flag to enable or disable the linting process of the Kotlin language. |
| **VALIDATE_KUBERNETES_KUBECONFORM** | `true` | Flag to enable or disable the linting process of Kubernetes descriptors with Kubeconform |
| **VALIDATE_LATEX** | `true` | Flag to enable or disable the linting process of the LaTeX language. |
| **VALIDATE_LUA** | `true` | Flag to enable or disable the linting process of the language. |
| **VALIDATE_MARKDOWN** | `true` | Flag to enable or disable the linting process of the Markdown language. |
| **VALIDATE_NATURAL_LANGUAGE** | `true` | Flag to enable or disable the linting process of the natural language. |
| **VALIDATE_OPENAPI** | `true` | Flag to enable or disable the linting process of the OpenAPI language. |
| **VALIDATE_PERL** | `true` | Flag to enable or disable the linting process of the Perl language. |
| **VALIDATE_PHP** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP built-in linter) (keep for backward compatibility) |
| **VALIDATE_PHP_BUILTIN** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP built-in linter) |
| **VALIDATE_PHP_PHPCS** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP CodeSniffer) |
| **VALIDATE_PHP_PHPSTAN** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHPStan) |
| **VALIDATE_PHP_PSALM** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PSalm) |
| **VALIDATE_POWERSHELL** | `true` | Flag to enable or disable the linting process of the Powershell language. |
| **VALIDATE_PROTOBUF** | `true` | Flag to enable or disable the linting process of the Protobuf language. |
| **VALIDATE_PYTHON** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: pylint) (keep for backward compatibility) |
| **VALIDATE_PYTHON_BLACK** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: black) |
| **VALIDATE_PYTHON_FLAKE8** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: flake8) |
| **VALIDATE_PYTHON_ISORT** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: isort) |
| **VALIDATE_PYTHON_MYPY** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: mypy) |
| **VALIDATE_PYTHON_PYLINT** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: pylint) |
2024-04-25 15:47:55 -04:00
| **VALIDATE_PYTHON_RUFF** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: ruff) |
2023-09-29 16:25:37 -04:00
| **VALIDATE_R** | `true` | Flag to enable or disable the linting process of the R language. |
| **VALIDATE_RAKU** | `true` | Flag to enable or disable the linting process of the Raku language. |
| **VALIDATE_RENOVATE** | `true` | Flag to enable or disable the linting process of the Renovate configuration files. |
| **VALIDATE_RUBY** | `true` | Flag to enable or disable the linting process of the Ruby language. |
| **VALIDATE_RUST_2015** | `true` | Flag to enable or disable the linting process of the Rust language. (edition: 2015) |
| **VALIDATE_RUST_2018** | `true` | Flag to enable or disable the linting process of Rust language. (edition: 2018) |
| **VALIDATE_RUST_2021** | `true` | Flag to enable or disable the linting process of Rust language. (edition: 2021) |
| **VALIDATE_RUST_CLIPPY** | `true` | Flag to enable or disable the clippy linting process of Rust language. |
| **VALIDATE_SCALAFMT** | `true` | Flag to enable or disable the linting process of Scala language. (Utilizing: scalafmt --test) |
| **VALIDATE_SHELL_SHFMT** | `true` | Flag to enable or disable the linting process of Shell scripts. (Utilizing: shfmt) |
| **VALIDATE_SNAKEMAKE_LINT** | `true` | Flag to enable or disable the linting process of Snakefiles. (Utilizing: snakemake --lint) |
| **VALIDATE_SNAKEMAKE_SNAKEFMT** | `true` | Flag to enable or disable the linting process of Snakefiles. (Utilizing: snakefmt) |
| **VALIDATE_STATES** | `true` | Flag to enable or disable the linting process for AWS States Language. |
| **VALIDATE_SQL** | `true` | Flag to enable or disable the linting process of the SQL language. |
| **VALIDATE_SQLFLUFF** | `true` | Flag to enable or disable the linting process of the SQL language. (Utilizing: sqlfuff) |
| **VALIDATE_TEKTON** | `true` | Flag to enable or disable the linting process of the Tekton language. |
| **VALIDATE_TERRAFORM_FMT** | `true` | Flag to enable or disable the formatting process of the Terraform files. |
| **VALIDATE_TERRAFORM_TERRASCAN** | `true` | Flag to enable or disable the linting process of the Terraform language for security related issues. |
| **VALIDATE_TERRAFORM_TFLINT** | `true` | Flag to enable or disable the linting process of the Terraform language. (Utilizing tflint) |
| **VALIDATE_TERRAGRUNT** | `true` | Flag to enable or disable the linting process for Terragrunt files. |
| **VALIDATE_TSX** | `true` | Flag to enable or disable the linting process for tsx files (Utilizing: ESLint) |
| **VALIDATE_TYPESCRIPT_ES** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ESLint) |
2024-07-19 01:04:43 -04:00
| **VALIDATE_TYPESCRIPT_PRETTIER** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: prettier) |
2023-09-29 16:25:37 -04:00
| **VALIDATE_TYPESCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ts-standard) |
| **VALIDATE_XML** | `true` | Flag to enable or disable the linting process of the XML language. |
| **VALIDATE_YAML** | `true` | Flag to enable or disable the linting process of the YAML language. |
| **YAML_CONFIG_FILE** | `.yaml-lint.yml` | Filename for [Yamllint configuration ](https://yamllint.readthedocs.io/en/stable/configuration.html ) (ex: `.yaml-lint.yml` , `.yamllint.yml` ) |
| **YAML_ERROR_ON_WARNING** | `false` | Flag to enable or disable the error on warning for Yamllint. |
2020-02-05 10:23:47 -05:00
2023-12-11 16:35:20 -05:00
The `VALIDATE_[LANGUAGE]` variables work as follows:
- super-linter runs all supported linters by default.
- If you set any of the `VALIDATE_[LANGUAGE]` variables to `true` , super-linter defaults to leaving any unset variable to false (only validate those languages).
- If you set any of the `VALIDATE_[LANGUAGE]` variables to `false` , super-linter defaults to leaving any unset variable to true (only exclude those languages).
- If you set any of the `VALIDATE_[LANGUAGE]` variables to both `true` and `false` , super-linter fails reporting an error.
2024-08-07 09:36:16 -04:00
For more information about reusing Super-linter configuration across
2023-12-11 16:35:20 -05:00
environments, see
[Share Environment variables between environments ](docs/run-linter-locally.md#share-environment-variables-between-environments ).
2024-08-07 09:36:16 -04:00
## Fix linting and formatting issues
All the linters and formatters that Super-linter runs report errors if they
detect linting or formatting issues without modifying your source
code (_check only mode_). Check only mode is the default for all linters and
formatters that Super-linter runs.
Certain linters and formatters support automatically fixing issues in your code
(_fix mode_). You can enable fix mode for a particular linter or formatter by
setting the relevant `FIX_<language name>` variable to `true` . To know which
linters and formatters support fix mode, refer to the
[Configure Super-linter section ](#configure-super-linter ).
Setting a `FIX_<language name>` variable to `true` implies setting the
corresponding `VALIDATE_<language name>` to `true` . Setting a
`FIX_<language name>` variable to `true` and the corresponding
`VALIDATE_<language name>` to `false` is a configuration error. Super-linter
reports that as a fatal error.
Super-linter supports the following locations to deliver fixes:
- In the current Super-linter workspace, so you can process the changes to your
files by yourself. For example:
- If you're running Super-linter in your CI environment, such as GitHub
Actions, you can commit and push changes as part of your workflow.
- If you're running Super-linter locally, you can commit the changes as you
would with any other change in your working directory.
2023-12-11 16:35:20 -05:00
## Configure linters
Super-linter provides default configurations for some linters in the [`TEMPLATES/` ](TEMPLATES/ )
directory. You can customize the configuration for the linters that support
this by placing your own configuration files in the `LINTER_RULES_PATH`
directory. `LINTER_RULES_PATH` is relative to the `DEFAULT_WORKSPACE` directory.
Super-linter supports customizing the name of these configuration files. For
more information, refer to [Configure super-linter ](#configure-super-linter ).
For example, you can configure super-linter to load configuration files from the
`config/lint` directory in your repository:
```yaml
env:
LINTER_RULES_PATH: `config/lint`
2022-02-09 16:24:57 -05:00
```
2023-12-11 16:35:20 -05:00
Some of the linters that super-linter provides can be configured to disable
certain rules or checks, and to ignore certain files or part of them.
For more information about how to configure each linter, review
[their own documentation ](#supported-linters-and-code-analyzers ).
## Include or exclude files from checks
2020-09-05 06:43:30 -04:00
2023-12-11 16:35:20 -05:00
If you need to include or exclude directories from being checked, you can use
two environment variables: `FILTER_REGEX_INCLUDE` and `FILTER_REGEX_EXCLUDE` .
2020-09-05 06:43:30 -04:00
2023-12-11 16:35:20 -05:00
For example:
2020-09-05 06:43:30 -04:00
2023-12-11 16:35:20 -05:00
- Lint only the `src` folder: `FILTER_REGEX_INCLUDE: .*src/.*`
2020-09-17 07:31:50 -04:00
- Do not lint files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*`
2021-10-05 09:29:05 -04:00
- Do not lint JavaScript files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*.js`
2020-09-05 06:43:30 -04:00
2021-06-28 08:59:11 -04:00
<!-- This `README.md` has both markers in the text, so it is considered not generated. -->
2023-12-11 16:35:20 -05:00
Additionally, if you set `IGNORE_GENERATED_FILES` to `true` , super-linter
ignores any file with `@generated` string in it, unless the file
also has `@not-generated` marker. For example, super-linter considers a file
with the following contents as generated:
2021-06-28 08:59:11 -04:00
```bash
#!/bin/sh
echo "@generated"
```
2023-12-11 16:35:20 -05:00
while considers this file as not generated:
2021-06-28 08:59:11 -04:00
```bash
#!/bin/sh
echo "@generated" # @not -generated
```
2023-12-11 16:35:20 -05:00
Finally, you can set `IGNORE_GITIGNORED_FILES` to `true` to ignore a file if Git
ignores it too.
2020-07-21 13:08:05 -04:00
2023-12-11 16:35:20 -05:00
## Run Super-Linter outside GitHub Actions
2019-10-21 10:12:50 -04:00
2023-12-11 16:35:20 -05:00
You don't need GitHub Actions to run super-linter. It supports several runtime
environments.
2020-06-24 15:45:26 -04:00
2023-12-11 16:35:20 -05:00
### Run using a container runtime engine
2020-07-21 13:08:05 -04:00
2023-12-11 16:35:20 -05:00
You can run super-linter outside GitHub Actions. For example, you can run
super-linter from a shell:
2020-07-14 20:14:01 -04:00
2023-12-11 16:35:20 -05:00
```bash
docker run \
2024-02-20 12:27:06 -05:00
-e LOG_LEVEL=DEBUG \
2023-12-11 16:35:20 -05:00
-e RUN_LOCAL=true \
-v /path/to/local/codebase:/tmp/lint \
ghcr.io/super-linter/super-linter:latest
```
2020-07-21 13:08:05 -04:00
2023-12-11 16:35:20 -05:00
For more information, see
[Run super-linter outside GitHub Actions ](https://github.com/super-linter/super-linter/blob/main/docs/run-linter-locally.md ).
2020-07-14 20:14:01 -04:00
2023-12-11 16:35:20 -05:00
## Use your own SSH key and certificate
2020-07-21 13:08:05 -04:00
2023-12-11 16:35:20 -05:00
If you need to use your own SSH key to authenticate against private
repositories, you can use the `SSH_KEY` environment variable. The value of that
2024-08-06 11:03:25 -04:00
environment variable is expected to be the private key of an SSH keypair that
2023-12-11 16:35:20 -05:00
has access to your private repositories.
2020-07-14 20:14:01 -04:00
2023-12-11 16:35:20 -05:00
For example, you can configure this private key as an
[Encrypted Secret ](https://docs.github.com/en/actions/security-guides/encrypted-secrets )
and access it with the `secrets` parameter from your GitHub Actions workflow:
2021-04-26 10:00:42 -04:00
2023-12-11 16:35:20 -05:00
```yaml
env:
SSH_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
```
2021-06-15 13:11:45 -04:00
2023-12-11 16:35:20 -05:00
If you need to inject a SSL certificate into the trust store, you can use the
`SSL_CERT_SECRET` variable. The value of that variable is expected to be the
2024-08-06 11:03:25 -04:00
path to the files that contains a CA that can be used to validate the certificate:
2021-06-15 13:11:45 -04:00
2023-12-11 16:35:20 -05:00
```yaml
2021-04-26 10:00:42 -04:00
env:
SSL_CERT_SECRET: ${{ secrets.ROOT_CA }}
```
2024-07-28 15:34:40 -04:00
## Outputs
Super-linter supports generating several outputs, and also supports exposing
the output of individual linters.
### Summary outputs
Super-linter writes a summary of all the checks:
- If `SAVE_SUPER_LINTER_SUMMARY` is set to `true` , Super-linter writes
a summary to
`${DEFAULT_WORKSPACE}/${SUPER_LINTER_OUTPUT_DIRECTORY_NAME}/${SUPER_LINTER_SUMMARY_FILE_NAME}` .
- If `ENABLE_GITHUB_ACTIONS_STEP_SUMMARY` is set to `true` , Super-linter writes
a GitHub Actions job summary. Setting `ENABLE_GITHUB_ACTIONS_STEP_SUMMARY` to
`true` , implies setting `SAVE_SUPER_LINTER_SUMMARY` to `true` .
The summary is in Markdown format. Super-linter supports the following formats:
- Table (default)
2024-07-30 02:35:14 -04:00
The summary output of previous Super-linter runs is not preserved.
2024-07-28 15:34:40 -04:00
### Super-linter outputs
2024-07-01 08:50:52 -04:00
If you set `SAVE_SUPER_LINTER_OUTPUT` to `true` , Super-linter saves its output
2024-07-28 15:34:40 -04:00
to `${DEFAULT_WORKSPACE}/${SUPER_LINTER_OUTPUT_DIRECTORY_NAME}/super-linter` , so you
2024-07-01 08:50:52 -04:00
can further process it, if needed.
Most outputs are in JSON format.
2024-07-28 15:34:40 -04:00
The output of previous Super-linter runs is not preserved.
2024-07-01 08:50:52 -04:00
2024-07-28 15:34:40 -04:00
### Linter reports and outputs
2024-07-01 08:50:52 -04:00
Some linters support configuring the format of their outputs for further
processing. To get access to that output, enable it using the respective linter
configuration file. If a linter requires a path for the output directory, you
can use the value of the `${DEFAULT_WORKSPACE}` variable.
If a linter doesn't support setting an arbitrary output path as described in the
previous paragraph, but only supports emitting results to standard output or
standard error streams, you can
[enable Super-linter outputs ](#super-linter-outputs ) and parse them.
2020-01-09 10:48:46 -05:00
## How to contribute
2020-07-21 13:08:05 -04:00
2023-12-11 16:35:20 -05:00
If you would like to help contribute to super-linter, see
2023-12-12 13:53:48 -05:00
[CONTRIBUTING ](https://github.com/super-linter/super-linter/blob/main/.github/CONTRIBUTING.md ).
