actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-12-22 20:52:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #79 from github/cleanupReadme

Browse source 
Adding linkage
This commit is contained in:
Lukas Gravley 2020-04-23 11:45:53 -05:00 committed by GitHub
commit 08bb027485
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -2,21 +2,23 @@
This repository is for the **GitHub Action** to run a **Super-Linter**. This repository is for the **GitHub Action** to run a **Super-Linter**.
Developers on **GitHub** can call this Action to lint their code base with the following list of linters: Developers on **GitHub** can call this Action to lint their code base with the following list of linters:
- **Ruby** (Rubocop) | *Language* | *Linter* |
- **Shell** (Shellcheck) |---|---|
- **Ansible** (Ansible-lint) | **Ruby** | Rubocop |
- **YAML** (Yamllint) | **Shell** | Shellcheck |
- **Python3** (Pylint) | **Ansible** | Ansible-lint |
- **JSON** (JsonLint) | **YAML** | Yamllint |
- **MarkDown** (Markdownlint) | **Python3** | Pylint |
- **Perl** (Perl) | **JSON** | JsonLint |
- **XML** (LibXML) | **MarkDown** | Markdownlint |
- **Coffeescript** (coffeelint) | **Perl** | Perl |
- **Javascript** (eslint)(standard) | **XML** | LibXML |
- **Typescript** (eslint)(standard) | **Coffeescript** | coffeelint |
- **Golang** (golangci-lint) | **Javascript** | eslint standard |
- **Dockerfile** (dockerfilelint) | **Typescript** | eslint standard |
- **Terraform** (tflint) | **Golang** | golangci-lint |
| **Dockerfile** | dockerfilelint |
| **Terraform** | tflint |
## How to use ## How to use
To use this **GitHub** Action you will need to complete the following: To use this **GitHub** Action you will need to complete the following:
@ -152,6 +154,9 @@ You can use the **GitHub** **Super-Linter** *with* or *without* your own persona
- Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/` of your repository - Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/` of your repository
- If your repository does not have rules files, they will fall back to defaults in this repositories `TEMPLATE` folder - If your repository does not have rules files, they will fall back to defaults in this repositories `TEMPLATE` folder
## Disabling rules
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://cloud.docker.com/u/admiralawkbar/repository/docker/admiralawkbar/super-linter`