From 99bc25cbfd513201c8de923ca6b6827603d97b52 Mon Sep 17 00:00:00 2001 From: Chris Nicel Date: Mon, 11 Jul 2022 18:52:36 +0100 Subject: [PATCH] Update run-linter-locally.md (#3104) 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 --- docs/run-linter-locally.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/run-linter-locally.md b/docs/run-linter-locally.md index 9fb6c336..78e697df 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -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