mirror of https://github.com/super-linter/super-linter.git synced 2024-12-26 01:02:08 -05:00

History

Brett Logan 985ef206aa Bump action version Signed-off-by: Brett Logan <lindluni@github.com>		2023-01-04 01:59:02 -05:00
..
action.yml	Bump action version	2023-01-04 01:59:02 -05:00
README.md	switch to main branch (#2010 )	2021-10-01 12:57:26 -07:00

README.md

GitHub Super-Linter Slim Image Action

The GitHub Super-Linter maintains two major images:

github/super-linter:v4
github/super-linter:slim-v4

In order to help users pull this image more naturally, the action.yml in this directory can help users pull the slim image.

Slim Image

The slim github/super-linter:slim-v4 comes with all supported linters but removes the following:

rust linters
dotenv linters
armttk linters
pwsh linters
c# linters

By removing these linters, we were able to bring the image size down by 2gb and drastically speed up the build and download time. The behavior will be the same for non-supported languages, and will skip languages at run time. Example usage:

################################
# Run Linter against code base #
################################
- name: Lint Code Base
  uses: github/super-linter/slim@v4
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: main
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}