diff --git a/docs/run-linter-locally.md b/docs/run-linter-locally.md index 3c23b8d3..a0097de0 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -24,7 +24,7 @@ You can follow the link below on how to install and configure **Docker** on your - You can run the container locally with the following **Base** flags to run your code: - `docker run -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase:/tmp/lint super-linter/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 super-linter/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 ghcr.io/super-linter/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 @@ -57,7 +57,7 @@ This always runs the local docker based linting. docker run --rm \ -e RUN_LOCAL=true \ --env-file ".github/super-linter.env" \ - -v "$PWD":/tmp/lint super-linter/super-linter:v5 + -v "$PWD":/tmp/lint ghcr.io/super-linter/super-linter:v5 ``` ### scripts/test @@ -103,7 +103,7 @@ jobs: If you need to run the container locally and gain access to its command-line, you can run the following command: -- `docker run -it --entrypoint /bin/bash super-linter/super-linter` +- `docker run -it --entrypoint /bin/bash ghcr.io/super-linter/super-linter` - This will drop you in the command-line of the docker container for any testing or troubleshooting that may be needed. ### Found issues