-
Notifications
You must be signed in to change notification settings - Fork 950
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create README.md * bump * Update README.md
- Loading branch information
1 parent
7038c42
commit 6585574
Showing
2 changed files
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }} |