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

added

Browse source
This commit is contained in:
Lucas Gravley 2019-10-23 12:23:46 -05:00
parent 2b02eeff72
commit 1796ac633c
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -17,15 +17,14 @@ Developers on **GitHub** can call this Action to lint their code base with the f
## 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:
- Copy **any** or **all** template rules files `TEMPLATES/` to your repository in the location: `.github/` - Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/`
- If your repository does not have rules files, they will fall back to defaults - If your repository does not have rules files, they will fall back to defaults in this repositories `TEMPLATE` folder
- Validate all variables are correct and allow for proper permissions on **AWS**
- Add the **Github** Action: **Super-Linter** to your current **Github** Actions workflow - Add the **Github** Action: **Super-Linter** to your current **Github** Actions workflow
- Enjoy your more stable, and cleaner code base - Enjoy your more stable, and cleaner code base
### Example GitHub Action Workflow ### Example connecting GitHub Action Workflow
In your repository you should have a `workflows` folder similar to below: In your repository you should have a `workflows` folder with **GitHub** Action similar to below:
- `.github/workflows/linter.yml` - `.github/workflows/linter.yml`