mirror of https://github.com/super-linter/super-linter.git synced 2024-12-22 15:22:16 -05:00

History

Grahame White 3a5ba0b431 Update docker image used by slim version of the action (#4505 ) Uses the updated super-linter/super-linter repo Bumps the slim image version to 5.2.0 to align with the full-fat version of the action		2023-08-07 19:09:19 +00:00
..
action.yml	Update docker image used by slim version of the action (#4505 )	2023-08-07 19:09:19 +00:00
README.md	updates `v4` references to `v5`	2023-04-14 13:59:00 -04:00

README.md

GitHub Super-Linter Slim Image Action

The GitHub Super-Linter maintains two major images:

github/super-linter:v5
github/super-linter:slim-v5

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-v5 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@v5
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: main
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}