mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-06 09:15:49 -05:00
Fix README issues (#1666)
This commit is contained in:
parent
16e0800480
commit
d5b94b9108
1 changed files with 7 additions and 1 deletions
|
@ -213,6 +213,7 @@ The available images:
|
||||||
|
|
||||||
The standard `github/super-linter:v4` comes with all supported linters.
|
The standard `github/super-linter:v4` comes with all supported linters.
|
||||||
Example usage:
|
Example usage:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
################################
|
################################
|
||||||
# Run Linter against code base #
|
# Run Linter against code base #
|
||||||
|
@ -228,14 +229,17 @@ Example usage:
|
||||||
#### Slim Image
|
#### Slim Image
|
||||||
|
|
||||||
The slim `github/super-linter:slim-v4` comes with all supported linters but removes the following:
|
The slim `github/super-linter:slim-v4` comes with all supported linters but removes the following:
|
||||||
|
|
||||||
- `rust` linters
|
- `rust` linters
|
||||||
- `dotenv` linters
|
- `dotenv` linters
|
||||||
- `armttk` linters
|
- `armttk` linters
|
||||||
- `pwsh` linters
|
- `pwsh` linters
|
||||||
- `c#` 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.
|
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.
|
The behavior will be the same for non-supported languages, and will skip languages at run time.
|
||||||
Example usage:
|
Example usage:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
################################
|
################################
|
||||||
# Run Linter against code base #
|
# Run Linter against code base #
|
||||||
|
@ -428,7 +432,9 @@ We will also support [GitHub Codespaces](https://github.com/features/codespaces/
|
||||||
If you need to inject a SSL cert into the trust store, you will need to first copy the cert to **GitHub Secrets**
|
If you need to inject a SSL cert into the trust store, you will need to first copy the cert to **GitHub Secrets**
|
||||||
Once you have copied the plain text certificate into **GitHub Secrets**, you can use the variable `SSL_CERT_SECRET` to point the **Super-Linter** to the files contents.
|
Once you have copied the plain text certificate into **GitHub Secrets**, you can use the variable `SSL_CERT_SECRET` to point the **Super-Linter** to the files contents.
|
||||||
Once found, it will load the certificate contents to a file, and to the trust store.
|
Once found, it will load the certificate contents to a file, and to the trust store.
|
||||||
|
|
||||||
- Example workflow:
|
- Example workflow:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
- name: Lint Code Base
|
- name: Lint Code Base
|
||||||
uses: github/super-linter@v4
|
uses: github/super-linter@v4
|
||||||
|
@ -439,7 +445,7 @@ Once found, it will load the certificate contents to a file, and to the trust st
|
||||||
|
|
||||||
## Community Activity
|
## Community Activity
|
||||||
|
|
||||||
<img src="https://cauldron.io/project/2083/stats.svg" >
|
![super-linter stats](https://cauldron.io/project/2083/stats.svg)
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue