From d20d93fec3068fca5c8d03b31e3f56745a4eeb47 Mon Sep 17 00:00:00 2001 From: Jason Lenny Date: Fri, 19 Jun 2020 11:47:45 +0200 Subject: [PATCH 1/3] Allow for workspace location to be provided by the end user This will give more flexibility to anyone who doesn't happen to keep their files in /tmp/lint. --- lib/linter.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/linter.sh b/lib/linter.sh index 4ea4461b..3ca9dd3d 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -100,7 +100,7 @@ ACTIONS_RUNNER_DEBUG="${ACTIONS_RUNNER_DEBUG}" # Boolean to see even more info # Default Vars # ################ DEFAULT_VALIDATE_ALL_CODEBASE='true' # Default value for validate all files -DEFAULT_WORKSPACE='/tmp/lint' # Default workspace if running locally +DEFAULT_WORKSPACE="${DEFAULT_WORKSPACE:-/tmp/lint}" # Default workspace if running locally DEFAULT_ANSIBLE_DIRECTORY="$GITHUB_WORKSPACE/ansible" # Default Ansible Directory DEFAULT_RUN_LOCAL='false' # Default value for debugging locally DEFAULT_TEST_CASE_RUN='false' # Flag to tell code to run only test cases From 14828eb478fbbe843ab1af973d2e2df0578ebb39 Mon Sep 17 00:00:00 2001 From: Jason Lenny Date: Fri, 19 Jun 2020 11:50:35 +0200 Subject: [PATCH 2/3] Add environment variable for running locally --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ef3de4fe..8e584d75 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,7 @@ and won't run anything unexpected. | **VALIDATE_TERRAFORM** | `true` | Flag to enable or disable the linting process of the language. | | **ANSIBLE_DIRECTORY** | `/ansible` | Flag to set the root directory for Ansible file location(s). | | **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. | +| **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. | ### Template rules files You can use the **GitHub** **Super-Linter** *with* or *without* your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level. From 248c421eda0031527e1461095269b4115f79ad8d Mon Sep 17 00:00:00 2001 From: Jason Lenny Date: Fri, 19 Jun 2020 11:52:14 +0200 Subject: [PATCH 3/3] Add instruction to running local page --- 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 d552f3f1..c28418b4 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -20,6 +20,7 @@ Once the container has been downloaded to your local environment, you can then b - `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` - **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 ### Flags for running Locally