feat: add option to disable the cleanup (#107)

.github/workflows/test.yml

@@ -33,11 +33,25 @@ jobs:
       - name: '📝 Creating files and folders'
         run: ./test/add_files.sh
 
+      - name: '⚙️ Run action'
+        env:
+          DISABLE_RUNNER_CLEANUP: true
+        uses: ./
+
+      - name: '✅ Test if workspace is not empty'
+        shell: bash
+        run: |
+          if [ "$(ls -A .)" ]; then
+            exit 0
+          else
+            echo "Workspace is not Empty"
+            exit 1
+          fi
+
       - name: '⚙️ Run action'
         uses: ./
 
       - name: '✅ Test if workspace is empty'
-        if: ${{ always() }} # Run even if previous steps in the job fail or are canceled
         shell: bash
         run: |
           if [ "$(ls -A .)" ]; then

README.md

@@ -16,6 +16,10 @@ steps:
   - uses: eviden-actions/clean-self-hosted-runner@v1
 ```
 
+### Options
+
+To disable the cleanup job (e.g. for debugging purpose), set the [environment variable](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#env) `DISABLE_RUNNER_CLEANUP` to **true**
+
 ### Example
 
 This is an example of a simple NPM build workflow that will clean the working directory after each execution.

action.yml

@@ -10,7 +10,8 @@ runs:
   steps:
     - id: step-1
       name: '🧹 Clean working directory'
-      if: ${{ always() }} # Run even if the job fails or is canceled
+      # If you want to disable the cleanup for e.g. debugging purpose, you can set the environment variable DISABLE_RUNNER_CLEANUP to true
+      if: ${{ always() && !env.DISABLE_RUNNER_CLEANUP}} # Run even if the job fails or is canceled
       shell: bash
       # TODO: evaluate rm -rf "${{ github.workspace }}"
       run: |