From 582549a430c9387e8abd3eb67359d8e59d374e3a Mon Sep 17 00:00:00 2001 From: Wen Zhou Date: Mon, 23 May 2022 22:00:47 +0200 Subject: [PATCH] docs: Update local run docker image with flag to disable check .git (#2894) folder Co-authored-by: Lukas Gravley --- docs/run-linter-locally.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/run-linter-locally.md b/docs/run-linter-locally.md index 69bf5b77ed5..9fb6c336ce9 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -23,8 +23,8 @@ You can follow the link below on how to install and configure **Docker** on your ## Run the container Locally - You can run the container locally with the following **Base** flags to run your code: - - `docker run -e RUN_LOCAL=true -v /path/to/local/codebase:/tmp/lint github/super-linter` - - To run against a single file you can use: `docker run -e RUN_LOCAL=true -v /path/to/local/codebase/file:/tmp/lint/file github/super-linter` + - `docker run -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase:/tmp/lint github/super-linter` + - To run against a single file you can use: `docker run -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase/file:/tmp/lint/file github/super-linter` - **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