mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-25 07:31:05 -05:00
Merge pull request #41 from github/jwiebalk/single_file
add command for single file
This commit is contained in:
commit
99cf75c85b
1 changed files with 1 additions and 0 deletions
1
.github/run-linter-locally.md
vendored
1
.github/run-linter-locally.md
vendored
|
@ -18,6 +18,7 @@ Once the container has been downloaded to your local environment, you can then b
|
|||
## 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 admiralawkbar/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 admiralawkbar/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:** 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
|
||||
- You can add as many **Additional** flags as needed:
|
||||
|
|
Loading…
Reference in a new issue