Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: adding slim action #1946

Merged
merged 1 commit into from
Sep 8, 2021
Merged

feat: adding slim action #1946

merged 1 commit into from
Sep 8, 2021

Conversation

sorenmat
Copy link
Contributor

@sorenmat sorenmat commented Sep 8, 2021

Fixes #

Proposed Changes

  1. Adding an sub action that can run using the slim image

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as breaking if this is a large fundamental change
  • Label as either automation, bug, documentation, enhancement, infrastructure, or performance

Copy link
Collaborator

@admiralAwkbar admiralAwkbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sorenmat

Great addition. I wanted to add a readme.md to slim/README.md to help users understand but looks like you don't have the permissions open enough for me to add it in...

If you want to finish up on this PR can you add the file?

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

README.md Show resolved Hide resolved
@admiralAwkbar admiralAwkbar added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 8, 2021
@admiralAwkbar admiralAwkbar merged commit 7038c42 into super-linter:master Sep 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants