actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-21 21:50:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

update readme

Browse source
This commit is contained in:
Lucas Gravley 2020-04-30 09:06:20 -05:00
parent 7975846c3c
commit 056fbd49e7
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,6 +1,14 @@
# Super-Linter # Super-Linter
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: It is a simple combination on various linters, written in `bash`, to help validate your source code.
The end goal of this tool:
- Prevent broken code from being uploaded to *master* branches
- Help establish coding best practices across multiple languages
- Build guidelines for code layout and format
- Automate the process to help streamline code reviews
Developers on **GitHub** can call the **GitHub Action** to lint their code base with the following list of linters:
| *Language* | *Linter* | | *Language* | *Linter* |
|---|---| |---|---|
@ -172,6 +180,12 @@ The **Super-Linter** has *CI/CT/CD* configured utilizing **GitHub** Actions.
- When the Pull Request is merged to master, the **Super-Linter** **Docker** container is then updated and deployed with the new codebase - When the Pull Request is merged to master, the **Super-Linter** **Docker** container is then updated and deployed with the new codebase
- **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
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 dependancies or change versions of the enclosed linters and binaries
- 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
## How to contribute ## How to contribute
If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/github/super-linter/blob/master/.github/CONTRIBUTING.md) If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/github/super-linter/blob/master/.github/CONTRIBUTING.md)