Add variable to change base path (#8)

* feat: ✨ add variable to change base path

When using this with a self-hosted runner where we have found the need to be able to change the base path of the installation.

* docs: 📝 add documentation on new input

* refactor: remove need to have `/` at the end of base_path variable

---------

Co-authored-by: Kenji Tagawa <kenji@tagawa.ca>

Author: kenjitagawa

README.md

@@ -28,6 +28,7 @@ Then, set up this Action as a step in your Actions workflow, e.g. for a typical
 * `java_version`: The Java version to use. Default: `11`
 * `no_cache`: Do not use cached versions of the Spotbugs and FindSecBugs tools. Default: `false`
 * `path_prefix`: Add this path prefix to the start of file locations. Required: `false`
+* `base_path`: The base path to use for installing the tools. Default: `/home/runner/work/`
 
 ## Full sample workflow
 

action.yml

@@ -44,6 +44,13 @@ inputs:
     description: 'Add this path prefix to the start of file locations'
     required: false
 
+  # Allows for a custom runner home directory to be specified for self-hosted runners
+  base_path:
+    description: 'The home directory of the runner'
+    required: false
+    default: '/home/runner/work'
+
+
 runs:
   using: "composite"
   steps:
@@ -57,20 +64,20 @@ runs:
       id: cache-spotbugs
       uses: actions/cache@v3
       with:
-        path: /home/runner/work/spotbugs+/spotbugs-${{ inputs.spotbugs_version }}
+        path: ${{ inputs.base_path }}/spotbugs+/spotbugs-${{ inputs.spotbugs_version }}
         key: ${{ runner.os }}-spotbugs-${{ inputs.spotbugs_version }}
     - name: Cache FindSecBugs
       if: inputs.no_cache == 'false'
       id: cache-findsecbugs
       uses: actions/cache@v3
       with:
-        path: /home/runner/work/findsecbugs+/findsecbugs-plugin-${{ inputs.findsecbugs_version }}.jar
+        path: ${{ inputs.base_path }}/findsecbugs+/findsecbugs-plugin-${{ inputs.findsecbugs_version }}.jar
         key: ${{ runner.os }}-findsecbugs-${{ inputs.findsecbugs_version }}
     - name: Get SpotBugs
       if: inputs.no_cache == 'true' || steps.cache-spotbugs.outputs.cache-hit != 'true'
       env:
         INPUT_SPOTBUGS_VERSION: ${{ inputs.spotbugs_version }}
-        SPOTBUGS_HOME: /home/runner/work/spotbugs+/
+        SPOTBUGS_HOME: ${{ inputs.base_path }}/spotbugs+/
       run: |
         mkdir -p "${SPOTBUGS_HOME}"
         cd "${SPOTBUGS_HOME}"
@@ -84,7 +91,7 @@ runs:
       if: inputs.no_cache == 'true' || steps.cache-findsecbugs.outputs.cache-hit != 'true'
       env:
         INPUT_FINDSECBUGS_VERSION: ${{ inputs.findsecbugs_version }}
-        FINDSECBUGS_HOME: /home/runner/work/findsecbugs+/
+        FINDSECBUGS_HOME: ${{ inputs.base_path }}/findsecbugs+/
       run: |
         mkdir -p "${FINDSECBUGS_HOME}"
         cd "${FINDSECBUGS_HOME}"
@@ -97,9 +104,9 @@ runs:
         INPUT_FINDSECBUGS_VERSION: ${{ inputs.findsecbugs_version }}
         INPUT_SPOTBUGS_TARGET: ${{ inputs.spotbugs_target }}
         INPUT_SPOTBUGS_GLOB: ${{ inputs.spotbugs_filename_glob }}
-        SPOTBUGS_HOME: /home/runner/work/spotbugs+/spotbugs-${{ inputs.spotbugs_version }}
-        FINDSECBUGS_HOME: /home/runner/work/findsecbugs+/
-        SPOTBUGS_WORKING: /home/runner/work/spotbugs_working+/
+        SPOTBUGS_HOME: ${{ inputs.base_path }}/spotbugs+/spotbugs-${{ inputs.spotbugs_version }}
+        FINDSECBUGS_HOME: ${{ inputs.base_path }}/findsecbugs+/
+        SPOTBUGS_WORKING: ${{ inputs.base_path }}/spotbugs_working+/
       run: |
         mkdir -p "${SPOTBUGS_WORKING}"
         cd "${SPOTBUGS_WORKING}"
@@ -110,7 +117,7 @@ runs:
       if: inputs.path_prefix != null
       env:
         INPUT_PATH_PREFIX: ${{ inputs.path_prefix }}
-        SPOTBUGS_WORKING: /home/runner/work/spotbugs_working+/
+        SPOTBUGS_WORKING: ${{ inputs.base_path }}/spotbugs_working+/
       run: |
         cd "${SPOTBUGS_WORKING}"
         jq --arg prefix "${INPUT_PATH_PREFIX}" '.runs[].results[].locations[].physicalLocation.artifactLocation.uri |= $prefix + .' < spotbugs.sarif > spotbugs_edited.sarif
@@ -121,4 +128,4 @@ runs:
       if: inputs.upload_sarif == 'true'
       uses: github/codeql-action/upload-sarif@v2
       with:
-        sarif_file: /home/runner/work/spotbugs_working+/spotbugs.sarif
+        sarif_file: ${{ inputs.base_path }}/spotbugs_working+/spotbugs.sarif