Merge branch 'master' into master

This commit is contained in:
Lukas Gravley 2020-06-18 12:08:11 -05:00 committed by GitHub
commit 5253dc32c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -18,18 +18,18 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
| *Language* | *Linter* | | *Language* | *Linter* |
|---|---| |---|---|
| **Ruby** | Rubocop | | **Ruby** | RuboCop |
| **Shell** | Shellcheck | | **Shell** | Shellcheck |
| **Ansible** | Ansible-lint | | **Ansible** | Ansible-lint |
| **YAML** | Yamllint | | **YAML** | Yamllint |
| **Python3** | Pylint | | **Python3** | Pylint |
| **JSON** | JsonLint | | **JSON** | JsonLint |
| **Markdown** | markdownlint | | **Markdown** | Markdownlint |
| **Perl** | Perl | | **Perl** | Perl |
| **XML** | LibXML | | **XML** | LibXML |
| **Coffeescript** | coffeelint | | **CoffeeScript** | coffeelint |
| **Javascript** | eslint standard | | **JavaScript** | eslint standard |
| **Typescript** | eslint standard | | **TypeScript** | eslint standard |
| **Golang** | golangci-lint | | **Golang** | golangci-lint |
| **Dockerfile** | dockerfilelint | | **Dockerfile** | dockerfilelint |
| **Terraform** | tflint | | **Terraform** | tflint |
@ -142,7 +142,7 @@ You can use the **GitHub** **Super-Linter** *with* or *without* your own persona
If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md) If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md)
## Docker Hub ## Docker Hub
The **Docker** container that is built from this repository is located at `https://cloud.docker.com/u/admiralawkbar/repository/docker/admiralawkbar/super-linter` The **Docker** container that is built from this repository is located at `https://hub.docker.com/r/admiralawkbar/super-linter`
## Running Super-Linter locally (troubleshooting/debugging/enhancements) ## Running Super-Linter locally (troubleshooting/debugging/enhancements)
If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md) If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md)
@ -157,9 +157,9 @@ The **Super-Linter** has *CI/CT/CD* configured utilizing **GitHub** Actions.
- **Note:** The branches **Docker** container is also removed from **DockerHub** to cleanup after itself - **Note:** The branches **Docker** container is also removed from **DockerHub** to cleanup after itself
## Limitations ## Limitations
Below are a list of the known limitations for the **Github Super-Linter**: Below are a list of the known limitations for the **GitHub Super-Linter**:
- Due to being completely packaged at run time, you will not be able to update dependencies or change versions of the enclosed linters and binaries - Due to being completely packaged at run time, you will not be able to update dependencies or change versions of the enclosed linters and binaries
- Reading additional details from `package.json` are not read by the **Github Super-Linter** - Reading additional details from `package.json` are not read by the **GitHub Super-Linter**
- Downloading additional codebases as dependencies from private repositories will fail due to lack of permissions - Downloading additional codebases as dependencies from private repositories will fail due to lack of permissions
## How to contribute ## How to contribute