mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-06 17:25:55 -05:00
commit
4513b63eeb
2 changed files with 8 additions and 4 deletions
12
README.md
12
README.md
|
@ -8,7 +8,6 @@ The end goal of this tool:
|
|||
- Build guidelines for code layout and format
|
||||
- Automate the process to help streamline code reviews
|
||||
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [How it works](#how-it-works)
|
||||
|
@ -60,10 +59,15 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
|
|||
| **YAML** | [YamlLint](https://github.com/adrienverge/yamllint) |
|
||||
|
||||
## How to use
|
||||
<img height="512" src="https://github.com/github/super-linter/blob/quickstart/docs/how-to.gif?raw=true" alt="How to gif">
|
||||
|
||||
To use this **GitHub** Action you will need to complete the following:
|
||||
- Add the **GitHub** Action: **Super-Linter** to your current **GitHub** Actions workflow
|
||||
- Enjoy your more *stable*, and *cleaner* code base
|
||||
- Check out the [Wiki](https://github.com/github/super-linter/wiki) for customization options
|
||||
1. Create a new file in your repository called `.github/workflows/linter.yml`
|
||||
2. Copy the example workflow from below into that new file, no extra configuration required
|
||||
3. Commit that file to a new branch
|
||||
4. Open up a pull request and observe the action working
|
||||
5. Enjoy your more *stable*, and *cleaner* code base
|
||||
6. Check out the [Wiki](https://github.com/github/super-linter/wiki) for customization options
|
||||
|
||||
### Example connecting GitHub Action Workflow
|
||||
In your repository you should have a `.github/workflows` folder with **GitHub** Action similar to below:
|
||||
|
|
BIN
docs/how-to.gif
Normal file
BIN
docs/how-to.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 17 MiB |
Loading…
Reference in a new issue