actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-21 21:50:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Create README.md (#1947)

Browse source 
* Create README.md

* bump

* Update README.md
This commit is contained in:
Lukas Gravley 2021-09-08 15:23:37 -05:00 committed by GitHub
parent 7038c42bff
commit 658557447c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
action.yml
View file

@ -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'

33
slim/README.md Normal file
View file

@ -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 }}