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

Update run-linter-locally.md (#3104)

Browse source 
Add note about `--rm` to remove the container after execution. This should prevent a build up of stopped containers after multiple runs of the super-linter
This commit is contained in:
Chris Nicel 2022-07-11 18:52:36 +01:00 committed by GitHub
parent b19a274295
commit 99bc25cbfd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/run-linter-locally.md
View file

@ -28,6 +28,7 @@ You can follow the link below on how to install and configure **Docker** on your
- **NOTE:** You need to pass the `RUN_LOCAL` flag to bypass some of the GitHub Actions checks, as well as the mapping of your local codebase to `/tmp/lint` so that the linter can pick up the code
- **NOTE:** If you want to override the `/tmp/lint` folder, you can set the `DEFAULT_WORKSPACE` environment variable to point to the folder you'd prefer to scan.
- **NOTE:** The flag:`RUN_LOCAL` will set: `VALIDATE_ALL_CODEBASE` to true. This means it will scan **all** the files in the directory you have mapped. If you want to only validate a subset of your codebase, map a folder with only the files you wish to have linted
- **NOTE:** Add the `--rm` docker flag to automatically remove the container after execution.
### Flags for running Locally