From 658557447ca5f49ca1ebaa125aa400a1c784911e Mon Sep 17 00:00:00 2001 From: Lukas Gravley Date: Wed, 8 Sep 2021 15:23:37 -0500 Subject: [PATCH] Create README.md (#1947) * Create README.md * bump * Update README.md --- action.yml | 2 +- slim/README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 slim/README.md diff --git a/action.yml b/action.yml index bc25ca21..c5ad8bf3 100644 --- a/action.yml +++ b/action.yml @@ -4,7 +4,7 @@ author: 'GitHub' description: 'It is a simple combination of various linters, written in bash, to help validate your source code.' runs: using: 'docker' - image: 'docker://ghcr.io/github/super-linter:v4.7.2' + image: 'docker://ghcr.io/github/super-linter:v4.7.3' branding: icon: 'check-square' color: 'white' diff --git a/slim/README.md b/slim/README.md new file mode 100644 index 00000000..53c088eb --- /dev/null +++ b/slim/README.md @@ -0,0 +1,33 @@ +# 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: + +```yml +################################ +# Run Linter against code base # +################################ +- name: Lint Code Base + uses: github/super-linter/slim@v4 + env: + VALIDATE_ALL_CODEBASE: false + DEFAULT_BRANCH: master + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}