Skip to content

Commit

Permalink
Create README.md (#1947)
Browse files Browse the repository at this point in the history
* Create README.md

* bump

* Update README.md
  • Loading branch information
admiralAwkbar committed Sep 8, 2021
1 parent 7038c42 commit 6585574
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
33 changes: 33 additions & 0 deletions slim/README.md
Original file line number Diff line number Diff line change
@@ -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 }}

0 comments on commit 6585574

Please sign in to comment.