Updated README.md (#1989)

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>

.all-contributorsrc

@@ -197,6 +197,54 @@
         "bug",
         "code"
       ]
+    },
+    {
+      "login": "rodrigorfk",
+      "name": "Rodrigo Fior Kuntzer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1995033?v=4",
+      "profile": "https://github.com/rodrigorfk",
+      "contributions": [
+        "code",
+        "test",
+        "bug"
+      ]
+    },
+    {
+      "login": "levenleven",
+      "name": "Aleksey Levenstein",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6463364?v=4",
+      "profile": "https://github.com/levenleven",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "dan-hill2802",
+      "name": "Daniel Hill",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5046322?v=4",
+      "profile": "https://github.com/dan-hill2802",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "KeisukeYamashita",
+      "name": "KeisukeYamashita",
+      "avatar_url": "https://avatars.githubusercontent.com/u/23056537?v=4",
+      "profile": "https://keisukeyamashita.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "codesculpture",
+      "name": "Aravind",
+      "avatar_url": "https://avatars.githubusercontent.com/u/63452117?v=4",
+      "profile": "https://github.com/codesculpture",
+      "contributions": [
+        "code",
+        "bug"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/auto-approve.yml

@@ -1,33 +0,0 @@
-name: Auto approve
-
-on:
-  pull_request_target
-
-
-jobs:
-  auto-approve:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: hmarr/auto-approve-action@v3
-        if: |
-          (
-            github.event.pull_request.user.login == 'dependabot[bot]' ||
-            github.event.pull_request.user.login == 'dependabot' ||
-            github.event.pull_request.user.login == 'dependabot-preview[bot]' ||
-            github.event.pull_request.user.login == 'dependabot-preview' ||
-            github.event.pull_request.user.login == 'renovate[bot]' ||
-            github.event.pull_request.user.login == 'renovate' ||
-            github.event.pull_request.user.login == 'github-actions[bot]'
-          )
-            &&
-          (
-            github.actor == 'dependabot[bot]' ||
-            github.actor == 'dependabot' ||
-            github.actor == 'dependabot-preview[bot]' ||
-            github.actor == 'dependabot-preview' ||
-            github.actor == 'renovate[bot]' ||
-            github.actor == 'renovate' ||
-            github.actor == 'github-actions[bot]'
-          )
-        with:
-          github-token: ${{ secrets.PAT_TOKEN }}

.github/workflows/codacy-analysis.yml

@@ -17,13 +17,13 @@ on:
   schedule:
     - cron: '15 16 * * 2'
 
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+
 jobs:
   codacy-security-scan:
-    # Cancel other workflows that are running for the same branch
-    # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency
-    concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}
-      cancel-in-progress: true
     name: Codacy Security Scan
     runs-on: ubuntu-latest
     steps:
@@ -34,7 +34,7 @@ jobs:
       # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
       - name: Run Codacy Analysis CLI
         continue-on-error: true
-        uses: codacy/codacy-analysis-cli-action@v4.3.0
+        uses: codacy/codacy-analysis-cli-action@v4.4.0
         with:
           # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
           # You can also omit the token and run the tools that support default configurations
@@ -51,6 +51,6 @@ jobs:
       # Upload the SARIF file generated in the previous step
       - name: Upload SARIF results file
         continue-on-error: true
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: results.sarif

.github/workflows/codeql.yml

@@ -20,6 +20,11 @@ on:
   schedule:
     - cron: '44 20 * * 0'
 
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+
 jobs:
   analyze:
     name: Analyze
@@ -42,7 +47,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -56,7 +61,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -69,6 +74,6 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/greetings.yml

@@ -2,12 +2,17 @@ name: Greetings
 
 on: [pull_request_target, issues]
 
+permissions:
+  pull-requests: write
+  issues: write
+
 jobs:
   greeting:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/first-interaction@v1
+        continue-on-error: true
         with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          repo-token: ${{ secrets.PAT_TOKEN }}
           issue-message: "Thanks for reporting this issue, don't forget to star this project if you haven't already to help us reach a wider audience."
           pr-message: "Thanks for implementing a fix, could you ensure that the test covers your changes if applicable."

.github/workflows/issue-comment-job-example.yml

@@ -1,4 +1,8 @@
-name: Issue Comment Test
+name: Issue Comment Job Example
+
+permissions:
+   contents: read
+
 on:
   issue_comment:
 

.github/workflows/manual-triggered-job-example.yml

@@ -1,9 +1,11 @@
-name: Manual Test
+name: Manual Triggered Job Example
+
+permissions:
+   contents: read
 
 on:
   workflow_dispatch:
 
-
 jobs:
   test:
     name: Test changed-files

.github/workflows/matrix-example.yml

@@ -1,4 +1,7 @@
-name: Matrix Test
+name: Matrix Example
+
+permissions:
+   contents: read
 
 on:
   workflow_dispatch:
@@ -8,10 +11,10 @@ on:
 
 jobs:
   changed-files:
-    name: Get changes
+    name: Get changed files
     runs-on: ubuntu-latest
     outputs:
-      matrix: ${{ steps.set-matrix.outputs.matrix }}
+      matrix: ${{ steps.changed-files.outputs.all_changed_files }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -21,19 +24,17 @@ jobs:
         id: changed-files
         uses: ./
         with:
-          json: true
-          quotepath: false
+          matrix: true
       - name: List all changed files
         run: echo '${{ steps.changed-files.outputs.all_changed_files }}'
-      - id: set-matrix
-        run: echo "matrix={\"files\":${{ steps.changed-files.outputs.all_changed_files }}}" >> "$GITHUB_OUTPUT"
 
   matrix-job:
     name: Run Matrix Job
     runs-on: ubuntu-latest
     needs: [changed-files]
     strategy:
-      matrix: ${{ fromJSON(needs.changed-files.outputs.matrix) }}
+      matrix: 
+        files: ${{ fromJSON(needs.changed-files.outputs.matrix) }}
       max-parallel: 4
       fail-fast: false
     steps:

.github/workflows/multi-job-example.yml

@@ -0,0 +1,67 @@
+name: Multi Job Example
+
+permissions:
+   contents: read
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    branches:
+      - "**"
+
+jobs:
+  changed-files:
+    name: Get changed files
+    runs-on: ubuntu-latest
+    outputs:
+      all_changed_files: ${{ steps.changed-files.outputs.all_changed_files }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Get changed files
+        id: changed-files
+        uses: ./
+      - name: List all changed files
+        run: echo '${{ steps.changed-files.outputs.all_changed_files }}'
+  
+  view-changed-files:
+    name: View all changed files
+    runs-on: ubuntu-latest
+    needs: [changed-files]
+    steps:
+      - name: List all changed files
+        run: |
+          echo '${{ needs.changed-files.outputs.all_changed_files }}'
+          
+
+  changed-files-rest-api:
+    name: Get changed files using REST API
+    runs-on: ubuntu-latest
+    outputs:
+      all_changed_files: ${{ steps.changed-files.outputs.all_changed_files }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Get changed files
+        id: changed-files
+        continue-on-error: ${{ github.event_name == 'push' }}
+        uses: ./
+        with:
+          use_rest_api: true
+      - name: List all changed files
+        run: echo '${{ steps.changed-files.outputs.all_changed_files }}'
+
+  view-changed-files-rest-api:
+    name: View all changed files using REST API
+    runs-on: ubuntu-latest
+    needs: [changed-files-rest-api]
+    steps:
+      - name: List all changed files
+        run: |
+          echo '${{ needs.changed-files-rest-api.outputs.all_changed_files }}'

.github/workflows/sync-release-version.yml

@@ -1,4 +1,9 @@
-name: Update release version.
+name: Update release version
+
+permissions:
+   contents: write
+   pull-requests: write
+
 on:
   release:
     types: [published]
@@ -32,7 +37,7 @@ jobs:
       - name: Run git-cliff
         uses: tj-actions/git-cliff@v1
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v5.0.2
+        uses: peter-evans/create-pull-request@v6.0.2
         with:
           base: "main"
           labels: "merge when passing"

.github/workflows/test.yml

@@ -1,12 +1,12 @@
 name: CI
 
+permissions:
+  contents: read
+
 on:
   push:
     branches:
       - "**"
-  pull_request_review:
-     types: [edited, dismissed, submitted]
-  pull_request_target:
   pull_request:
     types:
       - assigned
@@ -27,24 +27,16 @@ on:
       - auto_merge_enabled
       - auto_merge_disabled
     branches:
-      - main
-
+      - "**"
 
 jobs:
-  shellcheck:
-    name: Run shellcheck
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout branch
-        uses: actions/checkout@v4
-      - name: shellcheck
-        uses: reviewdog/action-shellcheck@v1.19
-
   build:
     runs-on: ubuntu-latest
     outputs:
       files_changed: ${{ steps.changed_files.outputs.files_changed }}
+    permissions:
+      contents: read
+      pull-requests: write
     steps:
       - uses: actions/checkout@v4
         with:
@@ -53,7 +45,7 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - name: Use Node.js 20.x
-        uses: actions/setup-node@v4.0.0
+        uses: actions/setup-node@v4.0.2
         with:
           cache: 'yarn'
           node-version: '20.x'
@@ -68,7 +60,7 @@ jobs:
           yarn install
 
       - name: Run eslint on changed files
-        uses: tj-actions/eslint-changed-files@v21
+        uses: tj-actions/eslint-changed-files@v23
         if: github.event_name == 'pull_request'
         with:
           token: ${{ secrets.PAT_TOKEN }}
@@ -80,7 +72,7 @@ jobs:
           yarn all
 
       - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v16
+        uses: tj-actions/verify-changed-files@v19
         id: changed_files
         with:
           files: |
@@ -104,7 +96,7 @@ jobs:
           branch: ${{ github.head_ref }}
 
       - name: Upload build assets
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: build-assets
           path: dist
@@ -121,6 +113,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     steps:
       - name: Checkout into dir1
         uses: actions/checkout@v4
@@ -131,7 +125,7 @@ jobs:
           path: dir1
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
           path: dir1/dist
@@ -157,7 +151,7 @@ jobs:
           bash
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
           path: dir2/dist
@@ -195,7 +189,8 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && needs.build.outputs.files_changed != 'true'
-
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
@@ -204,7 +199,7 @@ jobs:
           fetch-depth: 0
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -253,6 +248,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     steps:
       - name: Checkout branch
@@ -262,7 +259,7 @@ jobs:
           fetch-depth: 0
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -286,11 +283,17 @@ jobs:
         shell:
           bash
 
-  test-unset-github-output-env:
-    name: Test unset GITHUB_OUTPUT env
+  test-using-branch-names-for-base-sha-and-sha-inputs:
+    name: Test using branch names for base_sha and sha inputs
     runs-on: ubuntu-latest
     needs: build
-    if: needs.build.outputs.files_changed != 'true'
+    if: |
+      ( 
+        github.event_name == 'push' || 
+        github.event_name == 'pull_request'
+      ) && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     steps:
       - name: Checkout branch
@@ -300,16 +303,15 @@ jobs:
           fetch-depth: 0
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
-      - name: Run changed-files with unset GITHUB_OUTPUT env
+      - name: Run changed-files with main as the base_sha
         id: changed-files
-        continue-on-error: true
         uses: ./
-        env:
-          GITHUB_OUTPUT: ""
+        with:
+          base_sha: main
 
       - name: Show output
         run: |
@@ -322,6 +324,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     strategy:
       fail-fast: false
@@ -338,7 +342,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -361,6 +365,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: github.event_name != 'push' && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     steps:
       - name: Checkout branch
@@ -369,7 +375,7 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -388,6 +394,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: github.event_name != 'push' && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -403,7 +411,7 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -422,13 +430,14 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
-
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -476,13 +485,14 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
-
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -542,7 +552,7 @@ jobs:
           path: dir1
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
           path: dir1/dist
@@ -557,11 +567,83 @@ jobs:
         shell:
           bash
 
+  test-dir-names-nested-folder:
+    name: Test changed-files with dir-names in a nested folder
+    runs-on: ubuntu-latest
+    needs: build
+    if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: true
+          fetch-depth: 0
+
+      - name: Download build assets
+        uses: actions/download-artifact@v4
+        with:
+          name: build-assets
+          path: dist
+
+      - name: Get changed files in the .github folder
+        id: changed-files
+        uses: ./
+        with:
+          path: .github
+          json: true
+          escape_json: false
+          dir_names: true
+          dir_names_exclude_current_dir: true
+
+      - name: Show output
+        run: |
+          echo "${{ toJSON(steps.changed-files.outputs) }}"
+        shell:
+          bash
+
+  test-non-existing-repository:
+    name: Test changed-files with non existing repository
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout into dir1
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: true
+          fetch-depth: 0
+          path: dir1
+
+      - name: Download build assets
+        uses: actions/download-artifact@v4
+        with:
+          name: build-assets
+          path: dir1/dist
+
+      - name: Run changed-files with non existing repository
+        id: changed-files
+        continue-on-error: true
+        uses: ./dir1
+
+      - name: Verify failed
+        if: steps.changed-files.outcome != 'failure'
+        run: |
+          echo "Expected: (failure) got ${{ steps.changed-files.outcome }}"
+          exit 1
+
   test-submodules:
     name: Test changed-files with submodule
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read 
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -577,7 +659,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -605,6 +687,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -620,7 +704,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -652,11 +736,36 @@ jobs:
         shell:
           bash
 
+      - name: Run changed-files with files_yaml, json and write_output_files
+        id: changed-files-json-write-output-files
+        uses: ./
+        with:
+          files_yaml: |
+            test:
+              - .github/workflows/test.yml
+          json: true
+          write_output_files: true
+
+      - name: Show all outputs
+        run: |
+          echo "${{ toJSON(steps.changed-files-json-write-output-files.outputs) }}"
+        shell:
+          bash
+
+      - name: Show all_changed_files output and list .github/outputs
+        run: |
+          echo '${{ toJSON(steps.changed-files-json-write-output-files.outputs.test_all_changed_files) }}'
+          cat .github/outputs/test_all_changed_files.json
+        shell:
+          bash
+
   test-recover-deleted-file:
     name: Test changed-files recover deleted file
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -672,7 +781,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -812,11 +921,43 @@ jobs:
             cat "deleted_files/test/test deleted.txt"
           fi
 
+      - name: Run changed-files with recover_deleted_files for an expected git submodule file
+        id: changed-files-recover-deleted-files-within-submodule
+        uses: ./
+        with:
+          base_sha: "3be651e99d3d4eae395694f6c6f3b9d18457f6c8"
+          sha: "d90c240f2ad4ec04d8f0f48e5ac290ad96ebe850"
+          recover_deleted_files: true
+          fetch_depth: 60000
+
+      - name: Show output
+        run: |
+          echo "${{ toJSON(steps.changed-files-recover-deleted-files-within-submodule.outputs) }}"
+        shell:
+          bash
+
+      - name: Verify deleted files
+        if: steps.changed-files-recover-deleted-files-within-submodule.outputs.deleted_files != 'test/demo/.github/FUNDING.yml'
+        run: |
+          echo "Expected: (test/demo/.github/FUNDING.yml) got ${{ steps.changed-files-recover-deleted-files-within-submodule.outputs.deleted_files }}"
+          exit 1
+      - name: Verify that test/demo/.github/FUNDING.yml is restored
+        run: |
+          if [ ! -f "test/demo/.github/FUNDING.yml" ]; then
+            echo "Expected: (test/demo/.github/FUNDING.yml) to exist"
+            exit 1
+          else
+            cat "test/demo/.github/FUNDING.yml"
+            rm "test/demo/.github/FUNDING.yml"
+          fi
+
   test-dir-names-deleted-files-include-only-deleted-dirs-single-file:
     name: Test dir names deleted files include only deleted dirs single file
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
@@ -850,6 +991,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
@@ -891,6 +1034,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -907,7 +1052,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
   
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -941,6 +1086,8 @@ jobs:
     runs-on: ${{ matrix.platform }}
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -956,7 +1103,7 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           fetch-depth: ${{ matrix.fetch-depth }}
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
       - name: Dump GitHub context
@@ -971,7 +1118,7 @@ jobs:
           echo '${{ toJSON(steps.changed-files.outputs) }}'
         shell:
           bash
-      - name: Run changed-files with dir name
+      - name: Run changed-files with dir name pattern
         id: changed-files-dir-name
         uses: ./
         with:
@@ -1941,7 +2088,7 @@ jobs:
           bash
       - name: Get branch name
         id: branch-name
-        uses: tj-actions/branch-names@v7
+        uses: tj-actions/branch-names@v8
         if: github.event_name == 'pull_request' && matrix.fetch-depth == 0
       - uses: nrwl/nx-set-shas@v4
         id: last_successful_commit

.github/workflows/update-readme.yml

@@ -1,5 +1,9 @@
 name: Format README.md
 
+permissions:
+  contents: read
+  pull-requests: write
+
 on:
   push:
     branches:
@@ -15,12 +19,15 @@ jobs:
 
       - name: Run auto-doc
         uses: tj-actions/auto-doc@v3
+        with:
+          use_code_blocks: true
+          use_major_version: true
 
       - name: Run remark
         uses: tj-actions/remark@v3
 
       - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v16
+        uses: tj-actions/verify-changed-files@v19
         id: verify_changed_files
         with:
           files: |
@@ -34,7 +41,7 @@ jobs:
 
       - name: Create Pull Request
         if: failure()
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
         with:
           base: "main"
           labels: "merge when passing"

.github/workflows/workflow-run-example.yml

@@ -0,0 +1,41 @@
+name: Workflow Run Example
+on:
+  workflow_run:
+    workflows: [Matrix Example]
+    types: [completed]
+
+permissions:
+  contents: read
+
+jobs:
+  on-success:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get changed files
+        id: changed-files
+        uses: ./
+
+      - name: Echo list of changed files on success
+        run: |
+          echo "Changed files on success:"
+          echo "${{ steps.changed-files.outputs.all_changed_files }}"
+
+  on-failure:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get changed files
+        id: changed-files
+        uses: ./
+
+      - name: Echo list of changed files on failure
+        run: |
+          echo "Changed files on failure:"
+          echo "${{ steps.changed-files.outputs.all_changed_files }}"

SECURITY.md

@@ -0,0 +1,32 @@
+# Security Policy
+
+## Proactive Security Measures
+
+To proactively detect and address security vulnerabilities, we utilize several robust tools and processes:
+
+- **Dependency Updates:** We use [Renovate](https://renovatebot.com) and [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates) to keep our dependencies updated and promptly patch detected vulnerabilities through automated PRs.
+- **[GitHub's Security Features](https://github.com/features/security):** Our repository and dependencies are continuously monitored via GitHub's security features, which include:
+  - **Code Scanning:** Using GitHub's CodeQL, all pull requests are scanned to identify potential vulnerabilities in our source code.
+  - **Automated Alerts:** Dependabot identifies vulnerabilities based on the GitHub Advisory Database and opens PRs with patches, while automated [secret scanning](https://docs.github.com/en/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-partner-patterns) provides alerts for detected secrets.
+- **[GitGuardian Security Checks](https://www.gitguardian.com/):** We employ GitGuardian to ensure security checks are performed on the codebase, enhancing the overall security of our project.
+- **Code Analysis and Security Scanning:** With the help of [Codacy Static Code Analysis](https://www.codacy.com/) and [Codacy Security Scan](https://security.codacy.com/), we conduct thorough analyses and scans of our code for potential security risks.
+
+## Reporting Security Vulnerabilities
+
+Despite our best efforts to deliver secure software, we acknowledge the invaluable role of the community in identifying security breaches.
+
+### Private Vulnerability Disclosures
+
+We request all suspected vulnerabilities to be responsibly and privately disclosed by sending an email to [support@tj-actions.online](mailto:support@tj-actions.online).
+
+### Public Vulnerability Disclosures
+
+For publicly disclosed security vulnerabilities, please **IMMEDIATELY** email [support@tj-actions.online](mailto:support@tj-actions.online) with the details for prompt action.
+
+Upon confirmation of a breach, reporters will receive full credit and recognition for their contribution. Please note, that we do not offer monetary compensation for reporting vulnerabilities.
+
+## Communication of Security Breaches
+
+We will utilize the [GitHub Security Advisory](https://github.com/tj-actions/changed-files/security/advisories) to communicate any security breaches. The advisory will be made public once a patch has been released to rectify the issue.
+
+We appreciate your cooperation and contribution to maintaining the security of our software. Remember, a secure community is a strong community.

action.yml

@@ -4,11 +4,11 @@ author: tj-actions
 
 inputs:
   separator:
-    description: "Split character for output strings"
+    description: "Split character for output strings."
     required: false
     default: " "
   include_all_old_new_renamed_files:
-    description: "Include `all_old_new_renamed_files` output. Note this can generate a large output See: [#501](https://github.com/tj-actions/changed-files/issues/501)."
+    description: "Include `all_old_new_renamed_files` output. Note this can generate a large output See: #501."
     required: false
     default: "false"
   old_new_separator:
@@ -24,11 +24,13 @@ inputs:
     required: false
     default: ""
   files_from_source_file_separator:
-    description: 'Separator used to split the `files_from_source_file` input'
+    description: "Separator used to split the `files_from_source_file` input."
     default: "\n"
     required: false
   files:
-    description: "File and directory patterns used to detect changes (Defaults to the entire repo if unset) **NOTE:** Multiline file/directory patterns should not include quotes."
+    description: |
+      File and directory patterns used to detect changes (Defaults to the entire repo if unset).
+      NOTE: Multiline file/directory patterns should not include quotes.
     required: false
     default: ""
   files_separator:
@@ -40,7 +42,7 @@ inputs:
     required: false
     default: ""
   files_yaml_from_source_file:
-    description: "Source file(s) used to populate the `files_yaml` input. [Example](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml)"
+    description: "Source file(s) used to populate the `files_yaml` input. Example: https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml"
     required: false
     default: ""
   files_yaml_from_source_file_separator:
@@ -52,7 +54,7 @@ inputs:
     required: false
     default: ""
   files_ignore_yaml_from_source_file:
-    description: "Source file(s) used to populate the `files_ignore_yaml` input. [Example](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml)"
+    description: "Source file(s) used to populate the `files_ignore_yaml` input. Example: https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml"
     required: false
     default: ""
   files_ignore_yaml_from_source_file_separator:
@@ -60,7 +62,7 @@ inputs:
     default: "\n"
     required: false
   files_ignore:
-    description: "Ignore changes to these file(s) **NOTE:** Multiline file/directory patterns should not include quotes."
+    description: "Ignore changes to these file(s). NOTE: Multiline file/directory patterns should not include quotes."
     required: false
     default: ""
   files_ignore_separator:
@@ -76,10 +78,10 @@ inputs:
     default: "\n"
     required: false
   sha:
-    description: "Specify a different commit SHA used for comparing changes"
+    description: "Specify a different commit SHA or branch used for comparing changes"
     required: false
   base_sha:
-    description: "Specify a different base commit SHA used for comparing changes"
+    description: "Specify a different base commit SHA or branch used for comparing changes"
     required: false
   since:
     description: "Get changed files for commits whose timestamp is older than the given time."
@@ -94,16 +96,16 @@ inputs:
     required: false
     default: "."
   quotepath:
-    description: "Use non-ascii characters to match files and output the filenames completely verbatim by setting this to `false`"
+    description: "Use non-ASCII characters to match files and output the filenames completely verbatim by setting this to `false`"
     default: "true"
     required: false
   diff_relative:
-    description: "Exclude changes outside the current directory and show path names relative to it. **NOTE:** This requires you to specify the top level directory via the `path` input."
+    description: "Exclude changes outside the current directory and show path names relative to it. NOTE: This requires you to specify the top-level directory via the `path` input."
     required: false
     default: "true"
   dir_names:
     default: "false"
-    description: "Output unique changed directories instead of filenames. **NOTE:** This returns `.` for changed files located in the current working directory which defaults to `$GITHUB_WORKSPACE`."
+    description: "Output unique changed directories instead of filenames. NOTE: This returns `.` for changed files located in the current working directory which defaults to `$GITHUB_WORKSPACE`."
     required: false
   dir_names_max_depth:
     description: "Limit the directory output to a maximum depth e.g `test/test1/test2` with max depth of `2` returns `test/test1`."
@@ -113,7 +115,7 @@ inputs:
     required: false
     default: "false"
   dir_names_include_files:
-    description: "Include files in the output when `dir_names` is set to `true`. **NOTE:** This returns only the matching files and also the directory names."
+    description: "File and directory patterns to include in the output when `dir_names` is set to `true`. NOTE: This returns only the matching files and also the directory names."
     required: false
     default: ""
   dir_names_include_files_separator:
@@ -125,19 +127,25 @@ inputs:
     required: false
     default: "false"
   json:
-    description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs. [Example](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml)"
+    description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs. Example: https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml"
     required: false
     default: "false"
   escape_json:
     description: "Escape JSON output."
     required: false
     default: "true"
+  safe_output:
+    description: "Apply sanitization to output filenames before being set as output."
+    required: false
+    default: "true"
   fetch_depth:
-    description: "Depth of additional branch history fetched. **NOTE**: This can be adjusted to resolve errors with insufficient history."
+    description: "Depth of additional branch history fetched. NOTE: This can be adjusted to resolve errors with insufficient history."
     required: false
     default: "50"
   skip_initial_fetch:
-    description: "Skip the initial fetch to improve performance for shallow repositories. **NOTE**: This could lead to errors with missing history and the intended use is limited to when you've fetched the history necessary to perform the diff."
+    description: |
+      Skip initially fetching additional history to improve performance for shallow repositories.
+      NOTE: This could lead to errors with missing history. It's intended to be used when you've fetched all necessary history to perform the diff.
     required: false
     default: "false"
   fetch_additional_submodule_history:
@@ -149,7 +157,7 @@ inputs:
     required: false
     default: "false"
   write_output_files:
-    description: "Write outputs to the `output_dir` defaults to `.github/outputs` folder. **NOTE:** This creates a `.txt` file by default and a `.json` file if `json` is set to `true`."
+    description: "Write outputs to the `output_dir` defaults to `.github/outputs` folder. NOTE: This creates a `.txt` file by default and a `.json` file if `json` is set to `true`."
     required: false
     default: "false"
   output_dir:
@@ -169,7 +177,10 @@ inputs:
     required: false
     default: ""
   recover_files:
-    description: "File and directory patterns used to recover deleted files, defaults to the patterns provided via the `files`, `files_from_source_file`, `files_ignore` and `files_ignore_from_source_file` inputs or all deleted files if no patterns are provided."
+    description: |
+      File and directory patterns used to recover deleted files,
+      defaults to the patterns provided via the `files`, `files_from_source_file`, `files_ignore` and `files_ignore_from_source_file` inputs 
+      or all deleted files if no patterns are provided.
     required: false
     default: ""
   recover_files_separator:
@@ -185,13 +196,17 @@ inputs:
     default: "\n"
     required: false
   token:
-    description: "Github token used to fetch changed files from Github's API."
+    description: "GitHub token used to fetch changed files from Github's API."
     required: false
     default: ${{ github.token }}
   api_url:
     description: "Github API URL."
     required: false
     default: ${{ github.api_url }}
+  use_rest_api:
+    description: "Force the use of Github's REST API even when a local copy of the repository exists"
+    required: false
+    default: "false"
   fail_on_initial_diff_error:
     description: "Fail when the initial diff fails."
     required: false
@@ -200,6 +215,14 @@ inputs:
     description: "Fail when the submodule diff fails."
     required: false
     default: "false"
+  negation_patterns_first:
+    description: "Apply the negation patterns first. NOTE: This affects how changed files are matched."
+    required: false
+    default: "false"
+  matrix:
+    description: "Output changed files in a format that can be used for matrix jobs. Alias for setting inputs `json` to `true` and `escape_json` to `false`."
+    required: false
+    default: "false"
 
 outputs:
   added_files:
@@ -247,9 +270,9 @@ outputs:
   all_changed_files_count:
     description: "Returns the number of `all_changed_files`"
   any_changed:
-    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs has changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
+    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs have changed. This defaults to `true` when no patterns are specified. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
   only_changed:
-    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
+    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs have changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
   other_changed_files:
     description: "Returns all other changed files not listed in the files input i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
   other_changed_files_count:
@@ -259,17 +282,17 @@ outputs:
   all_modified_files_count:
     description: "Returns the number of `all_modified_files`"
   any_modified:
-    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs has been modified. i.e. *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*."
+    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs have been modified. This defaults to `true` when no patterns are specified. i.e. *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*."
   only_modified:
-    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has been modified. (ACMRD)."
+    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs have been modified. (ACMRD)."
   other_modified_files:
     description: "Returns all other modified files not listed in the files input i.e. *a combination of all added, copied, modified, and deleted files (ACMRD)*"
   other_modified_files_count:
     description: "Returns the number of `other_modified_files`"
   any_deleted:
-    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs has been deleted. (D)"
+    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs have been deleted. This defaults to `true` when no patterns are specified. (D)"
   only_deleted:
-    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has been deleted. (D)"
+    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs have been deleted. (D)"
   other_deleted_files:
     description: "Returns all other deleted files not listed in the files input i.e. *a  combination of all deleted files (D)*"
   other_deleted_files_count:

dist/licenses.txt

@@ -564,31 +564,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
-is-plain-object
-MIT
-The MIT License (MIT)
-
-Copyright (c) 2014-2017, Jon Schlinkert.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
 lodash
 MIT
 Copyright OpenJS Foundation and other contributors <https://openjsf.org/>

jest.config.js

@@ -10,4 +10,4 @@ module.exports = {
   setupFiles: [
     "<rootDir>/jest/setupEnv.cjs"
   ]
-}
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tj-actions/changed-files",
-  "version": "39.2.4",
+  "version": "42.1.0",
   "description": "Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories.",
   "main": "lib/main.js",
   "publishConfig": {
@@ -8,10 +8,10 @@
   },
   "scripts": {
     "build": "tsc",
-    "format": "prettier --write **/*.ts",
-    "format-check": "prettier --check **/*.ts",
-    "lint": "eslint **/*.ts --max-warnings 0",
-    "lint:fix": "eslint --fix src/**/*.ts",
+    "format": "prettier --write src/*.ts src/**/*.ts",
+    "format-check": "prettier --check src/*.ts src/**/*.ts",
+    "lint": "eslint src/*.ts src/**/*.ts --max-warnings 0",
+    "lint:fix": "eslint --fix src/*.ts src/**/*.ts",
     "package": "ncc build lib/main.js --source-map --license licenses.txt",
     "test": "jest --coverage",
     "all": "yarn build && yarn format && yarn lint && yarn package && yarn test"
@@ -46,8 +46,8 @@
     "@types/micromatch": "^4.0.2",
     "@types/node": "^20.3.2",
     "@types/uuid": "^9.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
     "@vercel/ncc": "^0.38.0",
     "eslint": "^8.43.0",
     "eslint-plugin-github": "^4.8.0",

src/__tests__/__snapshots__/inputs.test.ts.snap

@@ -0,0 +1,343 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getInputs should correctly parse boolean inputs 1`] = `
+{
+  "apiUrl": undefined,
+  "baseSha": undefined,
+  "diffRelative": "false",
+  "dirNames": "false",
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": "false",
+  "dirNamesExcludeCurrentDir": "false",
+  "dirNamesIncludeFiles": undefined,
+  "dirNamesIncludeFilesSeparator": undefined,
+  "escapeJson": false,
+  "failOnInitialDiffError": "false",
+  "failOnSubmoduleDiffError": "false",
+  "fetchAdditionalSubmoduleHistory": "false",
+  "files": undefined,
+  "filesFromSourceFile": undefined,
+  "filesFromSourceFileSeparator": undefined,
+  "filesIgnore": undefined,
+  "filesIgnoreFromSourceFile": undefined,
+  "filesIgnoreFromSourceFileSeparator": undefined,
+  "filesIgnoreSeparator": undefined,
+  "filesIgnoreYaml": undefined,
+  "filesIgnoreYamlFromSourceFile": undefined,
+  "filesIgnoreYamlFromSourceFileSeparator": undefined,
+  "filesSeparator": undefined,
+  "filesYaml": undefined,
+  "filesYamlFromSourceFile": undefined,
+  "filesYamlFromSourceFileSeparator": undefined,
+  "includeAllOldNewRenamedFiles": "false",
+  "json": true,
+  "negationPatternsFirst": "false",
+  "oldNewFilesSeparator": undefined,
+  "oldNewSeparator": undefined,
+  "outputDir": undefined,
+  "outputRenamedFilesAsDeletedAndAdded": "false",
+  "path": undefined,
+  "quotepath": "false",
+  "recoverDeletedFiles": "false",
+  "recoverDeletedFilesToDestination": undefined,
+  "recoverFiles": undefined,
+  "recoverFilesIgnore": undefined,
+  "recoverFilesIgnoreSeparator": undefined,
+  "recoverFilesSeparator": undefined,
+  "safeOutput": "false",
+  "separator": undefined,
+  "sha": undefined,
+  "since": undefined,
+  "sinceLastRemoteCommit": "false",
+  "skipInitialFetch": "true",
+  "token": undefined,
+  "until": undefined,
+  "useRestApi": "false",
+  "writeOutputFiles": "false",
+}
+`;
+
+exports[`getInputs should correctly parse numeric inputs 1`] = `
+{
+  "apiUrl": "",
+  "baseSha": "",
+  "diffRelative": true,
+  "dirNames": false,
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": false,
+  "dirNamesExcludeCurrentDir": false,
+  "dirNamesIncludeFiles": "",
+  "dirNamesIncludeFilesSeparator": "",
+  "dirNamesMaxDepth": 2,
+  "escapeJson": false,
+  "failOnInitialDiffError": false,
+  "failOnSubmoduleDiffError": false,
+  "fetchAdditionalSubmoduleHistory": false,
+  "fetchDepth": 5,
+  "files": "",
+  "filesFromSourceFile": "",
+  "filesFromSourceFileSeparator": "",
+  "filesIgnore": "",
+  "filesIgnoreFromSourceFile": "",
+  "filesIgnoreFromSourceFileSeparator": "",
+  "filesIgnoreSeparator": "",
+  "filesIgnoreYaml": "",
+  "filesIgnoreYamlFromSourceFile": "",
+  "filesIgnoreYamlFromSourceFileSeparator": "",
+  "filesSeparator": "",
+  "filesYaml": "",
+  "filesYamlFromSourceFile": "",
+  "filesYamlFromSourceFileSeparator": "",
+  "includeAllOldNewRenamedFiles": false,
+  "json": false,
+  "negationPatternsFirst": false,
+  "oldNewFilesSeparator": "",
+  "oldNewSeparator": "",
+  "outputDir": "",
+  "outputRenamedFilesAsDeletedAndAdded": false,
+  "path": "",
+  "quotepath": true,
+  "recoverDeletedFiles": false,
+  "recoverDeletedFilesToDestination": "",
+  "recoverFiles": "",
+  "recoverFilesIgnore": "",
+  "recoverFilesIgnoreSeparator": "",
+  "recoverFilesSeparator": "",
+  "safeOutput": false,
+  "separator": "",
+  "sha": "",
+  "since": "",
+  "sinceLastRemoteCommit": false,
+  "skipInitialFetch": false,
+  "token": "",
+  "until": "",
+  "useRestApi": false,
+  "writeOutputFiles": false,
+}
+`;
+
+exports[`getInputs should correctly parse string inputs 1`] = `
+{
+  "apiUrl": "https://api.github.com",
+  "baseSha": "",
+  "diffRelative": true,
+  "dirNames": false,
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": false,
+  "dirNamesExcludeCurrentDir": false,
+  "dirNamesIncludeFiles": "",
+  "dirNamesIncludeFilesSeparator": "",
+  "escapeJson": false,
+  "failOnInitialDiffError": false,
+  "failOnSubmoduleDiffError": false,
+  "fetchAdditionalSubmoduleHistory": false,
+  "files": "",
+  "filesFromSourceFile": "",
+  "filesFromSourceFileSeparator": "",
+  "filesIgnore": "",
+  "filesIgnoreFromSourceFile": "",
+  "filesIgnoreFromSourceFileSeparator": "",
+  "filesIgnoreSeparator": "",
+  "filesIgnoreYaml": "",
+  "filesIgnoreYamlFromSourceFile": "",
+  "filesIgnoreYamlFromSourceFileSeparator": "",
+  "filesSeparator": "",
+  "filesYaml": "",
+  "filesYamlFromSourceFile": "",
+  "filesYamlFromSourceFileSeparator": "",
+  "includeAllOldNewRenamedFiles": false,
+  "json": false,
+  "negationPatternsFirst": false,
+  "oldNewFilesSeparator": "",
+  "oldNewSeparator": "",
+  "outputDir": "",
+  "outputRenamedFilesAsDeletedAndAdded": false,
+  "path": "",
+  "quotepath": true,
+  "recoverDeletedFiles": false,
+  "recoverDeletedFilesToDestination": "",
+  "recoverFiles": "",
+  "recoverFilesIgnore": "",
+  "recoverFilesIgnoreSeparator": "",
+  "recoverFilesSeparator": "",
+  "safeOutput": false,
+  "separator": "",
+  "sha": "",
+  "since": "",
+  "sinceLastRemoteCommit": false,
+  "skipInitialFetch": false,
+  "token": "token",
+  "until": "",
+  "useRestApi": false,
+  "writeOutputFiles": false,
+}
+`;
+
+exports[`getInputs should handle invalid numeric inputs correctly 1`] = `
+{
+  "apiUrl": "",
+  "baseSha": "",
+  "diffRelative": true,
+  "dirNames": false,
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": false,
+  "dirNamesExcludeCurrentDir": false,
+  "dirNamesIncludeFiles": "",
+  "dirNamesIncludeFilesSeparator": "",
+  "dirNamesMaxDepth": 2,
+  "escapeJson": false,
+  "failOnInitialDiffError": false,
+  "failOnSubmoduleDiffError": false,
+  "fetchAdditionalSubmoduleHistory": false,
+  "fetchDepth": NaN,
+  "files": "",
+  "filesFromSourceFile": "",
+  "filesFromSourceFileSeparator": "",
+  "filesIgnore": "",
+  "filesIgnoreFromSourceFile": "",
+  "filesIgnoreFromSourceFileSeparator": "",
+  "filesIgnoreSeparator": "",
+  "filesIgnoreYaml": "",
+  "filesIgnoreYamlFromSourceFile": "",
+  "filesIgnoreYamlFromSourceFileSeparator": "",
+  "filesSeparator": "",
+  "filesYaml": "",
+  "filesYamlFromSourceFile": "",
+  "filesYamlFromSourceFileSeparator": "",
+  "includeAllOldNewRenamedFiles": false,
+  "json": false,
+  "negationPatternsFirst": false,
+  "oldNewFilesSeparator": "",
+  "oldNewSeparator": "",
+  "outputDir": "",
+  "outputRenamedFilesAsDeletedAndAdded": false,
+  "path": "",
+  "quotepath": true,
+  "recoverDeletedFiles": false,
+  "recoverDeletedFilesToDestination": "",
+  "recoverFiles": "",
+  "recoverFilesIgnore": "",
+  "recoverFilesIgnoreSeparator": "",
+  "recoverFilesSeparator": "",
+  "safeOutput": false,
+  "separator": "",
+  "sha": "",
+  "since": "",
+  "sinceLastRemoteCommit": false,
+  "skipInitialFetch": false,
+  "token": "",
+  "until": "",
+  "useRestApi": false,
+  "writeOutputFiles": false,
+}
+`;
+
+exports[`getInputs should handle negative numeric inputs correctly 1`] = `
+{
+  "apiUrl": "",
+  "baseSha": "",
+  "diffRelative": true,
+  "dirNames": false,
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": false,
+  "dirNamesExcludeCurrentDir": false,
+  "dirNamesIncludeFiles": "",
+  "dirNamesIncludeFilesSeparator": "",
+  "dirNamesMaxDepth": -2,
+  "escapeJson": false,
+  "failOnInitialDiffError": false,
+  "failOnSubmoduleDiffError": false,
+  "fetchAdditionalSubmoduleHistory": false,
+  "fetchDepth": 2,
+  "files": "",
+  "filesFromSourceFile": "",
+  "filesFromSourceFileSeparator": "",
+  "filesIgnore": "",
+  "filesIgnoreFromSourceFile": "",
+  "filesIgnoreFromSourceFileSeparator": "",
+  "filesIgnoreSeparator": "",
+  "filesIgnoreYaml": "",
+  "filesIgnoreYamlFromSourceFile": "",
+  "filesIgnoreYamlFromSourceFileSeparator": "",
+  "filesSeparator": "",
+  "filesYaml": "",
+  "filesYamlFromSourceFile": "",
+  "filesYamlFromSourceFileSeparator": "",
+  "includeAllOldNewRenamedFiles": false,
+  "json": false,
+  "negationPatternsFirst": false,
+  "oldNewFilesSeparator": "",
+  "oldNewSeparator": "",
+  "outputDir": "",
+  "outputRenamedFilesAsDeletedAndAdded": false,
+  "path": "",
+  "quotepath": true,
+  "recoverDeletedFiles": false,
+  "recoverDeletedFilesToDestination": "",
+  "recoverFiles": "",
+  "recoverFilesIgnore": "",
+  "recoverFilesIgnoreSeparator": "",
+  "recoverFilesSeparator": "",
+  "safeOutput": false,
+  "separator": "",
+  "sha": "",
+  "since": "",
+  "sinceLastRemoteCommit": false,
+  "skipInitialFetch": false,
+  "token": "",
+  "until": "",
+  "useRestApi": false,
+  "writeOutputFiles": false,
+}
+`;
+
+exports[`getInputs should return default values when no inputs are provided 1`] = `
+{
+  "apiUrl": undefined,
+  "baseSha": undefined,
+  "diffRelative": true,
+  "dirNames": false,
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": false,
+  "dirNamesExcludeCurrentDir": false,
+  "dirNamesIncludeFiles": undefined,
+  "dirNamesIncludeFilesSeparator": undefined,
+  "escapeJson": false,
+  "failOnInitialDiffError": false,
+  "failOnSubmoduleDiffError": false,
+  "fetchAdditionalSubmoduleHistory": false,
+  "files": undefined,
+  "filesFromSourceFile": undefined,
+  "filesFromSourceFileSeparator": undefined,
+  "filesIgnore": undefined,
+  "filesIgnoreFromSourceFile": undefined,
+  "filesIgnoreFromSourceFileSeparator": undefined,
+  "filesIgnoreSeparator": undefined,
+  "filesIgnoreYaml": undefined,
+  "filesIgnoreYamlFromSourceFile": undefined,
+  "filesIgnoreYamlFromSourceFileSeparator": undefined,
+  "filesSeparator": undefined,
+  "filesYaml": undefined,
+  "filesYamlFromSourceFile": undefined,
+  "filesYamlFromSourceFileSeparator": undefined,
+  "includeAllOldNewRenamedFiles": false,
+  "json": false,
+  "negationPatternsFirst": false,
+  "oldNewFilesSeparator": undefined,
+  "oldNewSeparator": undefined,
+  "outputDir": undefined,
+  "outputRenamedFilesAsDeletedAndAdded": false,
+  "path": undefined,
+  "quotepath": true,
+  "recoverDeletedFiles": false,
+  "recoverDeletedFilesToDestination": undefined,
+  "recoverFiles": undefined,
+  "recoverFilesIgnore": undefined,
+  "recoverFilesIgnoreSeparator": undefined,
+  "recoverFilesSeparator": undefined,
+  "safeOutput": false,
+  "separator": undefined,
+  "sha": undefined,
+  "since": undefined,
+  "sinceLastRemoteCommit": false,
+  "skipInitialFetch": false,
+  "token": undefined,
+  "until": undefined,
+  "useRestApi": false,
+  "writeOutputFiles": false,
+}
+`;

src/__tests__/inputs.test.ts

@@ -0,0 +1,153 @@
+import * as core from '@actions/core'
+import {getInputs, Inputs} from '../inputs'
+import {DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS} from '../constant'
+
+jest.mock('@actions/core')
+
+describe('getInputs', () => {
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('should return default values when no inputs are provided', () => {
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      const camelCaseName = name.replace(/_([a-z])/g, (g: string[]) => {
+        return g[1].toUpperCase()
+      }) as keyof Inputs
+
+      return (DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[camelCaseName] ||
+        '') as string
+    })
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      const camelCaseName = name.replace(/_([a-z])/g, (g: string[]) => {
+        return g[1].toUpperCase()
+      }) as keyof Inputs
+
+      return (DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[camelCaseName] ||
+        false) as boolean
+    })
+    expect(getInputs()).toMatchSnapshot()
+  })
+
+  test('should correctly parse boolean inputs', () => {
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      const camelCaseName = name.replace(/_([a-z])/g, (g: string[]) => {
+        return g[1].toUpperCase()
+      }) as keyof Inputs
+
+      return (DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[camelCaseName] ||
+        '') as string
+    })
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      switch (name) {
+        case 'matrix':
+          return 'true'
+        case 'skip_initial_fetch':
+          return 'true'
+        default:
+          return 'false'
+      }
+    })
+    expect(getInputs()).toMatchSnapshot()
+  })
+
+  test('should handle matrix alias correctly', () => {
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      return name === 'matrix' ? 'true' : 'false'
+    })
+
+    const inputs = getInputs()
+    expect(inputs).toHaveProperty('json', true)
+    expect(inputs).toHaveProperty('escapeJson', false)
+  })
+
+  test('should correctly parse string inputs', () => {
+    ;(core.getInput as jest.Mock).mockImplementation(name => {
+      switch (name) {
+        case 'token':
+          return 'token'
+        case 'api_url':
+          return 'https://api.github.com'
+        default:
+          return ''
+      }
+    })
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      const camelCaseName = name.replace(/_([a-z])/g, (g: string[]) => {
+        return g[1].toUpperCase()
+      }) as keyof Inputs
+
+      return (DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[camelCaseName] ||
+        false) as boolean
+    })
+    expect(getInputs()).toMatchSnapshot()
+  })
+
+  test('should correctly parse numeric inputs', () => {
+    ;(core.getInput as jest.Mock).mockImplementation(name => {
+      switch (name) {
+        case 'fetch_depth':
+          return '5'
+        case 'dir_names_max_depth':
+          return '2'
+        default:
+          return ''
+      }
+    })
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      const camelCaseName = name.replace(/_([a-z])/g, (g: string[]) => {
+        return g[1].toUpperCase()
+      }) as keyof Inputs
+
+      return (DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[camelCaseName] ||
+        false) as boolean
+    })
+    expect(getInputs()).toMatchSnapshot()
+  })
+
+  test('should handle invalid numeric inputs correctly', () => {
+    ;(core.getInput as jest.Mock).mockImplementation(name => {
+      // TODO: Add validation for invalid numbers which should result in an error instead of NaN
+      switch (name) {
+        case 'fetch_depth':
+          return 'invalid'
+        case 'dir_names_max_depth':
+          return '2'
+        default:
+          return ''
+      }
+    })
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      const camelCaseName = name.replace(/_([a-z])/g, (g: string[]) => {
+        return g[1].toUpperCase()
+      }) as keyof Inputs
+
+      return (DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[camelCaseName] ||
+        false) as boolean
+    })
+    expect(getInputs()).toMatchSnapshot()
+  })
+
+  test('should handle negative numeric inputs correctly', () => {
+    ;(core.getInput as jest.Mock).mockImplementation(name => {
+      // TODO: Add validation for negative numbers which should result in an error
+      switch (name) {
+        case 'fetch_depth':
+          return '-5'
+        case 'dir_names_max_depth':
+          return '-2'
+        default:
+          return ''
+      }
+    })
+    ;(core.getBooleanInput as jest.Mock).mockImplementation(name => {
+      const camelCaseName = name.replace(/_([a-z])/g, (g: string[]) => {
+        return g[1].toUpperCase()
+      }) as keyof Inputs
+
+      return (DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[camelCaseName] ||
+        false) as boolean
+    })
+    expect(getInputs()).toMatchSnapshot()
+  })
+})

src/__tests__/main.test.ts

@@ -1,5 +0,0 @@
-describe('main test', () => {
-  it('adds two numbers', async () => {
-    expect(1 + 1).toEqual(2)
-  })
-})

src/__tests__/utils.test.ts

@@ -1,9 +1,12 @@
+import * as core from '@actions/core'
 import {ChangeTypeEnum} from '../changedFiles'
+import {Inputs} from '../inputs'
 import {
   getDirname,
   getDirnameMaxDepth,
   getFilteredChangedFiles,
-  normalizeSeparators
+  normalizeSeparators,
+  warnUnsupportedRESTAPIInputs
 } from '../utils'
 
 const originalPlatform = process.platform
@@ -575,4 +578,77 @@ describe('utils test', () => {
       expect(filteredFiles[ChangeTypeEnum.Modified]).toEqual([])
     })
   })
+
+  describe('warnUnsupportedRESTAPIInputs', () => {
+    // Warns about unsupported inputs when using the REST API.
+    it('should warn about unsupported inputs when all inputs are supported', async () => {
+      const inputs: Inputs = {
+        files: '',
+        filesSeparator: '\n',
+        filesFromSourceFile: '',
+        filesFromSourceFileSeparator: '\n',
+        filesYaml: '',
+        filesYamlFromSourceFile: '',
+        filesYamlFromSourceFileSeparator: '\n',
+        filesIgnore: '',
+        filesIgnoreSeparator: '\n',
+        filesIgnoreFromSourceFile: '',
+        filesIgnoreFromSourceFileSeparator: '\n',
+        filesIgnoreYaml: '',
+        filesIgnoreYamlFromSourceFile: '',
+        filesIgnoreYamlFromSourceFileSeparator: '\n',
+        separator: ' ',
+        includeAllOldNewRenamedFiles: false,
+        oldNewSeparator: ',',
+        oldNewFilesSeparator: ' ',
+        sha: '1313123',
+        baseSha: '',
+        since: '',
+        until: '',
+        path: '.',
+        quotepath: true,
+        diffRelative: true,
+        dirNames: false,
+        dirNamesMaxDepth: undefined,
+        dirNamesExcludeCurrentDir: false,
+        dirNamesIncludeFiles: '',
+        dirNamesIncludeFilesSeparator: '\n',
+        dirNamesDeletedFilesIncludeOnlyDeletedDirs: false,
+        json: false,
+        escapeJson: true,
+        safeOutput: true,
+        fetchDepth: 50,
+        fetchAdditionalSubmoduleHistory: false,
+        sinceLastRemoteCommit: false,
+        writeOutputFiles: false,
+        outputDir: '.github/outputs',
+        outputRenamedFilesAsDeletedAndAdded: false,
+        recoverDeletedFiles: false,
+        recoverDeletedFilesToDestination: '',
+        recoverFiles: '',
+        recoverFilesSeparator: '\n',
+        recoverFilesIgnore: '',
+        recoverFilesIgnoreSeparator: '\n',
+        token: '${{ github.token }}',
+        apiUrl: '${{ github.api_url }}',
+        skipInitialFetch: false,
+        failOnInitialDiffError: false,
+        failOnSubmoduleDiffError: false,
+        negationPatternsFirst: false,
+        useRestApi: false
+      }
+
+      const coreWarningSpy = jest.spyOn(core, 'warning')
+
+      await warnUnsupportedRESTAPIInputs({
+        inputs
+      })
+
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        'Input "sha" is not supported when using GitHub\'s REST API to get changed files'
+      )
+
+      expect(coreWarningSpy).toHaveBeenCalledTimes(1)
+    })
+  })
 })

src/changedFiles.ts

@@ -166,7 +166,7 @@ export const getRenamedFiles = async ({
           }))
         ) {
           let message = `Unable to use three dot diff for: ${submodulePath} submodule. Falling back to two dot diff. You can set 'fetch_additional_submodule_history: true' to fetch additional submodule history in order to use three dot diff`
-          if (inputs.fetchSubmoduleHistory) {
+          if (inputs.fetchAdditionalSubmoduleHistory) {
             message = `To fetch additional submodule history for: ${submodulePath} you can increase history depth using 'fetch_depth' input`
           }
           core.info(message)
@@ -221,7 +221,7 @@ export const getAllDiffFiles = async ({
   diffResult,
   submodulePaths,
   outputRenamedFilesAsDeletedAndAdded,
-  fetchSubmoduleHistory,
+  fetchAdditionalSubmoduleHistory,
   failOnInitialDiffError,
   failOnSubmoduleDiffError
 }: {
@@ -230,7 +230,7 @@ export const getAllDiffFiles = async ({
   diffResult: DiffResult
   submodulePaths: string[]
   outputRenamedFilesAsDeletedAndAdded: boolean
-  fetchSubmoduleHistory: boolean
+  fetchAdditionalSubmoduleHistory: boolean
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
 }): Promise<ChangedFiles> => {
@@ -270,7 +270,7 @@ export const getAllDiffFiles = async ({
           }))
         ) {
           let message = `Set 'fetch_additional_submodule_history: true' to fetch additional submodule history for: ${submodulePath}`
-          if (fetchSubmoduleHistory) {
+          if (fetchAdditionalSubmoduleHistory) {
             message = `To fetch additional submodule history for: ${submodulePath} you can increase history depth using 'fetch_depth' input`
           }
           core.warning(message)

src/changedFilesOutput.ts

@@ -43,7 +43,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
   await setOutput({
     key: getOutputKey('added_files_count', outputPrefix),
@@ -64,7 +65,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -86,7 +88,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -108,7 +111,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -130,7 +134,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -152,7 +157,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -174,7 +180,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -199,7 +206,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -226,7 +234,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -238,7 +247,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
 
   await setOutput({
     key: getOutputKey('any_changed', outputPrefix),
-    value: allChangedFiles.paths.length > 0 && filePatterns.length > 0,
+    value: allChangedFiles.paths.length > 0,
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json
@@ -314,7 +323,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -326,7 +336,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
 
   await setOutput({
     key: getOutputKey('any_modified', outputPrefix),
-    value: allModifiedFiles.paths.length > 0 && filePatterns.length > 0,
+    value: allModifiedFiles.paths.length > 0,
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json
@@ -419,7 +429,8 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 
   await setOutput({
@@ -431,7 +442,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
 
   await setOutput({
     key: getOutputKey('any_deleted', outputPrefix),
-    value: deletedFiles.paths.length > 0 && filePatterns.length > 0,
+    value: deletedFiles.paths.length > 0,
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json
@@ -485,7 +496,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
   })
 
   return {
-    anyModified: allModifiedFiles.paths.length > 0 && filePatterns.length > 0,
-    anyChanged: allChangedFiles.paths.length > 0 && filePatterns.length > 0
+    anyModified: allModifiedFiles.paths.length > 0,
+    anyChanged: allChangedFiles.paths.length > 0
   }
 }

src/commitSha.ts

@@ -5,6 +5,7 @@ import {Env} from './env'
 import {Inputs} from './inputs'
 import {
   canDiffCommits,
+  cleanShaInput,
   getCurrentBranchName,
   getHeadSha,
   getParentSha,
@@ -23,7 +24,11 @@ const getCurrentSHA = async ({
   inputs: Inputs
   workingDirectory: string
 }): Promise<string> => {
-  let currentSha = inputs.sha
+  let currentSha = await cleanShaInput({
+    sha: inputs.sha,
+    cwd: workingDirectory,
+    token: inputs.token
+  })
   core.debug('Getting current SHA...')
 
   if (inputs.until) {
@@ -147,7 +152,7 @@ export const getSHAForNonPullRequestEvent = async (
         })
       }
     } else {
-      if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+      if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -162,7 +167,11 @@ export const getSHAForNonPullRequestEvent = async (
   }
 
   const currentSha = await getCurrentSHA({inputs, workingDirectory})
-  let previousSha = inputs.baseSha
+  let previousSha = await cleanShaInput({
+    sha: inputs.baseSha,
+    cwd: workingDirectory,
+    token: inputs.token
+  })
   const diff = '..'
   const currentBranchName = await getCurrentBranchName({cwd: workingDirectory})
 
@@ -175,7 +184,7 @@ export const getSHAForNonPullRequestEvent = async (
     currentBranch = currentBranchName
   }
 
-  if (previousSha && currentSha && currentBranch && targetBranch) {
+  if (inputs.baseSha && inputs.sha && currentBranch && targetBranch) {
     if (previousSha === currentSha) {
       core.error(
         `Similar commit hashes detected: previous sha: ${previousSha} is equivalent to the current sha: ${currentSha}.`
@@ -186,7 +195,6 @@ export const getSHAForNonPullRequestEvent = async (
       throw new Error('Similar commit hashes detected.')
     }
 
-    await verifyCommitSha({sha: previousSha, cwd: workingDirectory})
     core.debug(`Previous SHA: ${previousSha}`)
 
     return {
@@ -198,7 +206,7 @@ export const getSHAForNonPullRequestEvent = async (
     }
   }
 
-  if (!previousSha) {
+  if (!previousSha || previousSha === currentSha) {
     core.debug('Getting previous SHA...')
     if (inputs.since) {
       core.debug(`Getting base SHA for '${inputs.since}'...`)
@@ -374,7 +382,7 @@ export const getSHAForPullRequestEvent = async (
         }
       }
     } else {
-      if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+      if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -390,10 +398,14 @@ export const getSHAForPullRequestEvent = async (
   }
 
   const currentSha = await getCurrentSHA({inputs, workingDirectory})
-  let previousSha = inputs.baseSha
+  let previousSha = await cleanShaInput({
+    sha: inputs.baseSha,
+    cwd: workingDirectory,
+    token: inputs.token
+  })
   let diff = '...'
 
-  if (previousSha && currentSha && currentBranch && targetBranch) {
+  if (inputs.baseSha && inputs.sha && currentBranch && targetBranch) {
     if (previousSha === currentSha) {
       core.error(
         `Similar commit hashes detected: previous sha: ${previousSha} is equivalent to the current sha: ${currentSha}.`
@@ -404,7 +416,6 @@ export const getSHAForPullRequestEvent = async (
       throw new Error('Similar commit hashes detected.')
     }
 
-    await verifyCommitSha({sha: previousSha, cwd: workingDirectory})
     core.debug(`Previous SHA: ${previousSha}`)
 
     return {
@@ -418,12 +429,12 @@ export const getSHAForPullRequestEvent = async (
 
   if (
     !github.context.payload.pull_request?.base?.ref ||
-    github.context.payload.head?.repo?.fork === 'true'
+    github.context.payload.pull_request?.head?.repo?.fork === true
   ) {
     diff = '..'
   }
 
-  if (!previousSha) {
+  if (!previousSha || previousSha === currentSha) {
     if (inputs.sinceLastRemoteCommit) {
       previousSha = github.context.payload.before
 

src/constant.ts

@@ -0,0 +1,24 @@
+import {Inputs} from './inputs'
+
+export const DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS: Partial<Inputs> = {
+  sha: '',
+  baseSha: '',
+  since: '',
+  until: '',
+  path: '.',
+  quotepath: true,
+  diffRelative: true,
+  sinceLastRemoteCommit: false,
+  recoverDeletedFiles: false,
+  recoverDeletedFilesToDestination: '',
+  recoverFiles: '',
+  recoverFilesSeparator: '\n',
+  recoverFilesIgnore: '',
+  recoverFilesIgnoreSeparator: '\n',
+  includeAllOldNewRenamedFiles: false,
+  oldNewSeparator: ',',
+  oldNewFilesSeparator: ' ',
+  skipInitialFetch: false,
+  fetchAdditionalSubmoduleHistory: false,
+  dirNamesDeletedFilesIncludeOnlyDeletedDirs: false
+}

src/env.ts

@@ -5,8 +5,9 @@ export type Env = {
   GITHUB_REF: string
   GITHUB_WORKSPACE: string
 }
+
 export const getEnv = async (): Promise<Env> => {
-  core.debug(`Process Env: ${JSON.stringify(process.env, null, 2)}`)
+  core.debug(`Env: ${JSON.stringify(process.env, null, 2)}`)
 
   return {
     GITHUB_REF_NAME: process.env.GITHUB_REF_NAME || '',

src/inputs.ts

@@ -24,7 +24,7 @@ export type Inputs = {
   since: string
   until: string
   path: string
-  quotePath: boolean
+  quotepath: boolean
   diffRelative: boolean
   dirNames: boolean
   dirNamesMaxDepth?: number
@@ -34,8 +34,9 @@ export type Inputs = {
   dirNamesDeletedFilesIncludeOnlyDeletedDirs: boolean
   json: boolean
   escapeJson: boolean
+  safeOutput: boolean
   fetchDepth?: number
-  fetchSubmoduleHistory: boolean
+  fetchAdditionalSubmoduleHistory: boolean
   sinceLastRemoteCommit: boolean
   writeOutputFiles: boolean
   outputDir: string
@@ -51,6 +52,8 @@ export type Inputs = {
   skipInitialFetch: boolean
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
+  negationPatternsFirst: boolean
+  useRestApi: boolean
 }
 
 export const getInputs = (): Inputs => {
@@ -129,7 +132,7 @@ export const getInputs = (): Inputs => {
   const since = core.getInput('since', {required: false})
   const until = core.getInput('until', {required: false})
   const path = core.getInput('path', {required: false})
-  const quotePath = core.getBooleanInput('quotepath', {required: false})
+  const quotepath = core.getBooleanInput('quotepath', {required: false})
   const diffRelative = core.getBooleanInput('diff_relative', {required: false})
   const dirNames = core.getBooleanInput('dir_names', {required: false})
   const dirNamesMaxDepth = core.getInput('dir_names_max_depth', {
@@ -151,8 +154,16 @@ export const getInputs = (): Inputs => {
       trimWhitespace: false
     }
   )
-  const json = core.getBooleanInput('json', {required: false})
-  const escapeJson = core.getBooleanInput('escape_json', {required: false})
+  let json = core.getBooleanInput('json', {required: false})
+  let escapeJson = core.getBooleanInput('escape_json', {required: false})
+  const matrix = core.getBooleanInput('matrix', {required: false})
+
+  if (matrix) {
+    json = true
+    escapeJson = false
+  }
+
+  const safeOutput = core.getBooleanInput('safe_output', {required: false})
   const fetchDepth = core.getInput('fetch_depth', {required: false})
   const sinceLastRemoteCommit = core.getBooleanInput(
     'since_last_remote_commit',
@@ -193,7 +204,7 @@ export const getInputs = (): Inputs => {
   const skipInitialFetch = core.getBooleanInput('skip_initial_fetch', {
     required: false
   })
-  const fetchSubmoduleHistory = core.getBooleanInput(
+  const fetchAdditionalSubmoduleHistory = core.getBooleanInput(
     'fetch_additional_submodule_history',
     {
       required: false
@@ -218,6 +229,17 @@ export const getInputs = (): Inputs => {
     }
   )
 
+  const negationPatternsFirst = core.getBooleanInput(
+    'negation_patterns_first',
+    {
+      required: false
+    }
+  )
+
+  const useRestApi = core.getBooleanInput('use_rest_api', {
+    required: false
+  })
+
   const inputs: Inputs = {
     files,
     filesSeparator,
@@ -242,7 +264,7 @@ export const getInputs = (): Inputs => {
     since,
     until,
     path,
-    quotePath,
+    quotepath,
     diffRelative,
     sinceLastRemoteCommit,
     recoverDeletedFiles,
@@ -255,7 +277,7 @@ export const getInputs = (): Inputs => {
     oldNewSeparator,
     oldNewFilesSeparator,
     skipInitialFetch,
-    fetchSubmoduleHistory,
+    fetchAdditionalSubmoduleHistory,
     dirNamesDeletedFilesIncludeOnlyDeletedDirs,
     // End Not Supported via REST API
     dirNames,
@@ -264,11 +286,14 @@ export const getInputs = (): Inputs => {
     dirNamesIncludeFilesSeparator,
     json,
     escapeJson,
+    safeOutput,
     writeOutputFiles,
     outputDir,
     outputRenamedFilesAsDeletedAndAdded,
     token,
-    apiUrl
+    apiUrl,
+    negationPatternsFirst,
+    useRestApi
   }
 
   if (fetchDepth) {

src/main.ts

@@ -26,7 +26,8 @@ import {
   setOutput,
   submoduleExists,
   updateGitGlobalConfig,
-  verifyMinimumGitVersion
+  verifyMinimumGitVersion,
+  warnUnsupportedRESTAPIInputs
 } from './utils'
 
 const getChangedFilesFromLocalGitHistory = async ({
@@ -44,15 +45,15 @@ const getChangedFilesFromLocalGitHistory = async ({
 }): Promise<void> => {
   await verifyMinimumGitVersion()
 
-  let quotePathValue = 'on'
+  let quotepathValue = 'on'
 
-  if (!inputs.quotePath) {
-    quotePathValue = 'off'
+  if (!inputs.quotepath) {
+    quotepathValue = 'off'
   }
 
   await updateGitGlobalConfig({
     name: 'core.quotepath',
-    value: quotePathValue
+    value: quotepathValue
   })
 
   if (inputs.diffRelative) {
@@ -123,7 +124,7 @@ const getChangedFilesFromLocalGitHistory = async ({
     diffResult,
     submodulePaths,
     outputRenamedFilesAsDeletedAndAdded,
-    fetchSubmoduleHistory: inputs.fetchSubmoduleHistory,
+    fetchAdditionalSubmoduleHistory: inputs.fetchAdditionalSubmoduleHistory,
     failOnInitialDiffError: inputs.failOnInitialDiffError,
     failOnSubmoduleDiffError: inputs.failOnSubmoduleDiffError
   })
@@ -144,7 +145,9 @@ const getChangedFilesFromLocalGitHistory = async ({
       workingDirectory,
       deletedFiles: allDiffFiles[ChangeTypeEnum.Deleted],
       recoverPatterns,
-      sha: diffResult.previousSha
+      diffResult,
+      hasSubmodule,
+      submodulePaths
     })
   }
 
@@ -171,7 +174,8 @@ const getChangedFilesFromLocalGitHistory = async ({
       value: allOldNewRenamedFiles.paths,
       writeOutputFiles: inputs.writeOutputFiles,
       outputDir: inputs.outputDir,
-      json: inputs.json
+      json: inputs.json,
+      safeOutput: inputs.safeOutput
     })
     await setOutput({
       key: 'all_old_new_renamed_files_count',
@@ -221,7 +225,7 @@ export async function run(): Promise<void> {
 
   const workingDirectory = path.resolve(
     env.GITHUB_WORKSPACE || process.cwd(),
-    inputs.path
+    inputs.useRestApi ? '.' : inputs.path
   )
   core.debug(`Working directory: ${workingDirectory}`)
 
@@ -240,35 +244,19 @@ export async function run(): Promise<void> {
   })
   core.debug(`Yaml file patterns: ${JSON.stringify(yamlFilePatterns)}`)
 
+  if (inputs.useRestApi && !github.context.payload.pull_request?.number) {
+    throw new Error(
+      "Only pull_request* events are supported when using GitHub's REST API."
+    )
+  }
+
   if (
     inputs.token &&
     github.context.payload.pull_request?.number &&
-    !hasGitDirectory
+    (!hasGitDirectory || inputs.useRestApi)
   ) {
     core.info("Using GitHub's REST API to get changed files")
-    const unsupportedInputs: (keyof Inputs)[] = [
-      'sha',
-      'baseSha',
-      'since',
-      'until',
-      'sinceLastRemoteCommit',
-      'recoverDeletedFiles',
-      'recoverDeletedFilesToDestination',
-      'recoverFiles',
-      'recoverFilesIgnore',
-      'includeAllOldNewRenamedFiles',
-      'skipInitialFetch',
-      'fetchSubmoduleHistory',
-      'dirNamesDeletedFilesIncludeOnlyDeletedDirs'
-    ]
-
-    for (const input of unsupportedInputs) {
-      if (inputs[input]) {
-        core.warning(
-          `Input "${input}" is not supported when using GitHub's REST API to get changed files`
-        )
-      }
-    }
+    await warnUnsupportedRESTAPIInputs({inputs})
     await getChangedFilesFromRESTAPI({
       inputs,
       filePatterns,
@@ -276,10 +264,9 @@ export async function run(): Promise<void> {
     })
   } else {
     if (!hasGitDirectory) {
-      core.setFailed(
-        "Can't find local .git directory. Please run actions/checkout before this action"
+      throw new Error(
+        `Unable to locate the git repository in the given path: ${workingDirectory}.\n Please run actions/checkout before this action (Make sure the 'path' input is correct).\n If you intend to use Github's REST API note that only pull_request* events are supported. Current event is "${github.context.eventName}".`
       )
-      return
     }
 
     core.info('Using local .git directory')
@@ -298,5 +285,6 @@ if (!process.env.TESTING) {
   // eslint-disable-next-line github/no-then
   run().catch(e => {
     core.setFailed(e.message || e)
+    process.exit(1)
   })
 }

src/utils.ts

@@ -1,14 +1,16 @@
 /*global AsyncIterableIterator*/
 import * as core from '@actions/core'
 import * as exec from '@actions/exec'
+import * as github from '@actions/github'
 import {createReadStream, promises as fs} from 'fs'
-import {readFile} from 'fs/promises'
-import {flattenDeep} from 'lodash'
+import {flattenDeep, snakeCase} from 'lodash'
 import mm from 'micromatch'
 import * as path from 'path'
 import {createInterface} from 'readline'
 import {parseDocument} from 'yaml'
 import {ChangedFiles, ChangeTypeEnum} from './changedFiles'
+import {DiffResult} from './commitSha'
+import {DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS} from './constant'
 import {Inputs} from './inputs'
 
 const MINIMUM_GIT_VERSION = '2.18.0'
@@ -169,15 +171,16 @@ async function* lineOfFileGenerator({
     input: fileStream,
     crlfDelay: Infinity
   })
-  for await (const line of rl) {
+  for await (let line of rl) {
     if (!line.startsWith('#') && line !== '') {
       if (excludedFiles) {
-        if (line.startsWith('!')) {
-          yield line
-        } else {
-          yield `!${line}`
+        line = line.startsWith('!') ? line : `!${line}`
+        if (line.endsWith(path.sep)) {
+          line = `${line}**`
         }
+        yield line
       } else {
+        line = line.endsWith(path.sep) ? `${line}**` : line
         yield line
       }
     }
@@ -283,6 +286,7 @@ export const submoduleExists = async ({
  * Fetches the git repository
  * @param args - arguments for fetch command
  * @param cwd - working directory
+ * @returns exit code
  */
 export const gitFetch = async ({
   args,
@@ -331,6 +335,7 @@ export const gitFetchSubmodules = async ({
 /**
  * Retrieves all the submodule paths
  * @param cwd - working directory
+ * @returns submodule paths
  */
 export const getSubmodulePath = async ({
   cwd
@@ -365,6 +370,7 @@ export const getSubmodulePath = async ({
  * @param parentSha2 - parent commit sha
  * @param submodulePath - path of submodule
  * @param diff - diff type between parent commits (`..` or `...`)
+ * @returns commit sha of submodule
  */
 export const gitSubmoduleDiffSHA = async ({
   cwd,
@@ -674,6 +680,12 @@ export const isInsideWorkTree = async ({
     }
   )
 
+  if (stdout.trim() !== 'true') {
+    core.warning(
+      `The current working directory is not inside a git repository: ${cwd}`
+    )
+  }
+
   return stdout.trim() === 'true'
 }
 
@@ -771,6 +783,56 @@ export const verifyCommitSha = async ({
   return exitCode
 }
 
+/**
+ * Clean the sha from the input which could be a branch name or a commit sha.
+ *
+ * If the input is a valid commit sha, return it as is.
+ *
+ * If the input is a branch name, get the HEAD sha of that branch and return it.
+ *
+ * @param sha The input string, which could be a branch name or a commit sha.
+ * @param cwd The working directory.
+ * @param token The GitHub token.
+ * @returns The cleaned SHA string.
+ */
+export const cleanShaInput = async ({
+  sha,
+  cwd,
+  token
+}: {
+  sha: string
+  cwd: string
+  token: string
+}): Promise<string> => {
+  // Check if the input is a valid commit sha
+  if (!sha) {
+    return sha
+  }
+  // Check if the input is a valid commit sha
+  const {stdout, exitCode} = await exec.getExecOutput(
+    'git',
+    ['rev-parse', '--verify', `${sha}^{commit}`],
+    {
+      cwd,
+      ignoreReturnCode: true,
+      silent: !core.isDebug()
+    }
+  )
+
+  if (exitCode !== 0) {
+    const octokit = github.getOctokit(token)
+    // If it's not a valid commit sha, assume it's a branch name and get the HEAD sha
+    const {data: refData} = await octokit.rest.git.getRef({
+      owner: github.context.repo.owner,
+      repo: github.context.repo.repo,
+      ref: `heads/${sha}`
+    })
+
+    return refData.object.sha
+  }
+
+  return stdout.trim()
+}
 export const getPreviousGitTag = async ({
   cwd
 }: {
@@ -846,7 +908,7 @@ export const canDiffCommits = async ({
   } else {
     const {exitCode, stderr} = await exec.getExecOutput(
       'git',
-      ['diff', '--quiet', sha1, sha2],
+      ['diff', '--no-patch', sha1, sha2],
       {
         cwd,
         ignoreReturnCode: true,
@@ -938,77 +1000,101 @@ export const getFilePatterns = async ({
   inputs: Inputs
   workingDirectory: string
 }): Promise<string[]> => {
-  let filePatterns = inputs.files
-    .split(inputs.filesSeparator)
-    .filter(Boolean)
-    .join('\n')
+  let cleanedFilePatterns: string[] = []
+
+  if (inputs.files) {
+    const filesPatterns = inputs.files
+      .split(inputs.filesSeparator)
+      .map(p => (p.endsWith(path.sep) ? `${p}**` : p))
+      .filter(Boolean)
+
+    cleanedFilePatterns.push(...filesPatterns)
+
+    core.debug(`files patterns: ${filesPatterns.join('\n')}`)
+  }
 
   if (inputs.filesFromSourceFile !== '') {
     const inputFilesFromSourceFile = inputs.filesFromSourceFile
       .split(inputs.filesFromSourceFileSeparator)
-      .filter(p => p !== '')
+      .filter(Boolean)
       .map(p => path.join(workingDirectory, p))
 
     core.debug(`files from source file: ${inputFilesFromSourceFile}`)
 
-    const filesFromSourceFiles = (
-      await getFilesFromSourceFile({filePaths: inputFilesFromSourceFile})
-    ).join('\n')
+    const filesFromSourceFiles = await getFilesFromSourceFile({
+      filePaths: inputFilesFromSourceFile
+    })
 
-    core.debug(`files from source files patterns: ${filesFromSourceFiles}`)
+    core.debug(
+      `files from source files patterns: ${filesFromSourceFiles.join('\n')}`
+    )
 
-    filePatterns = filePatterns.concat('\n', filesFromSourceFiles)
+    cleanedFilePatterns.push(...filesFromSourceFiles)
   }
 
   if (inputs.filesIgnore) {
     const filesIgnorePatterns = inputs.filesIgnore
       .split(inputs.filesIgnoreSeparator)
-      .filter(p => p !== '')
+      .filter(Boolean)
       .map(p => {
-        if (!p.startsWith('!')) {
-          p = `!${p}`
+        p = p.startsWith('!') ? p : `!${p}`
+        if (p.endsWith(path.sep)) {
+          p = `${p}**`
         }
         return p
       })
-      .join('\n')
 
-    core.debug(`files ignore patterns: ${filesIgnorePatterns}`)
+    core.debug(`files ignore patterns: ${filesIgnorePatterns.join('\n')}`)
 
-    filePatterns = filePatterns.concat('\n', filesIgnorePatterns)
+    cleanedFilePatterns.push(...filesIgnorePatterns)
   }
 
   if (inputs.filesIgnoreFromSourceFile) {
     const inputFilesIgnoreFromSourceFile = inputs.filesIgnoreFromSourceFile
       .split(inputs.filesIgnoreFromSourceFileSeparator)
-      .filter(p => p !== '')
+      .filter(Boolean)
       .map(p => path.join(workingDirectory, p))
 
     core.debug(
       `files ignore from source file: ${inputFilesIgnoreFromSourceFile}`
     )
 
-    const filesIgnoreFromSourceFiles = (
-      await getFilesFromSourceFile({
-        filePaths: inputFilesIgnoreFromSourceFile,
-        excludedFiles: true
-      })
-    ).join('\n')
+    const filesIgnoreFromSourceFiles = await getFilesFromSourceFile({
+      filePaths: inputFilesIgnoreFromSourceFile,
+      excludedFiles: true
+    })
 
     core.debug(
-      `files ignore from source files patterns: ${filesIgnoreFromSourceFiles}`
+      `files ignore from source files patterns: ${filesIgnoreFromSourceFiles.join(
+        '\n'
+      )}`
     )
 
-    filePatterns = filePatterns.concat('\n', filesIgnoreFromSourceFiles)
+    cleanedFilePatterns.push(...filesIgnoreFromSourceFiles)
+  }
+
+  if (inputs.negationPatternsFirst) {
+    cleanedFilePatterns.sort((a, b) => {
+      return a.startsWith('!') ? -1 : b.startsWith('!') ? 1 : 0
+    })
+  }
+
+  // Reorder file patterns '**' should come first
+  if (cleanedFilePatterns.includes('**')) {
+    cleanedFilePatterns.sort((a, b) => {
+      return a === '**' ? -1 : b === '**' ? 1 : 0
+    })
   }
 
   if (isWindows()) {
-    filePatterns = filePatterns.replace(/\r\n/g, '\n')
-    filePatterns = filePatterns.replace(/\r/g, '\n')
+    cleanedFilePatterns = cleanedFilePatterns.map(pattern =>
+      pattern.replace(/\r\n/g, '\n').replace(/\r/g, '\n')
+    )
   }
 
-  core.debug(`Input file patterns: ${filePatterns}`)
+  core.debug(`Input file patterns: \n${cleanedFilePatterns.join('\n')}`)
 
-  return filePatterns.trim().split('\n').filter(Boolean)
+  return cleanedFilePatterns
 }
 
 // Example YAML input:
@@ -1054,7 +1140,7 @@ const getYamlFilePatternsFromContents = async ({
       throw new Error(`File does not exist: ${filePath}`)
     }
 
-    source = await readFile(filePath, 'utf8')
+    source = await fs.readFile(filePath, 'utf8')
   } else {
     source = content
   }
@@ -1250,7 +1336,8 @@ export const setArrayOutput = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 }
 
@@ -1260,7 +1347,8 @@ export const setOutput = async ({
   writeOutputFiles,
   outputDir,
   json = false,
-  shouldEscape = false
+  shouldEscape = false,
+  safeOutput = false
 }: {
   key: string
   value: string | string[] | boolean
@@ -1268,6 +1356,7 @@ export const setOutput = async ({
   outputDir: string
   json?: boolean
   shouldEscape?: boolean
+  safeOutput?: boolean
 }): Promise<void> => {
   let cleanedValue
   if (json) {
@@ -1276,6 +1365,11 @@ export const setOutput = async ({
     cleanedValue = value.toString().trim()
   }
 
+  // if safeOutput is true, escape special characters for bash shell
+  if (safeOutput) {
+    cleanedValue = cleanedValue.replace(/[^\x20-\x7E]|[:*?<>|;`$()&!]/g, '\\$&')
+  }
+
   core.setOutput(key, cleanedValue)
 
   if (writeOutputFiles) {
@@ -1322,13 +1416,17 @@ export const recoverDeletedFiles = async ({
   workingDirectory,
   deletedFiles,
   recoverPatterns,
-  sha
+  diffResult,
+  hasSubmodule,
+  submodulePaths
 }: {
   inputs: Inputs
   workingDirectory: string
   deletedFiles: string[]
   recoverPatterns: string[]
-  sha: string
+  diffResult: DiffResult
+  hasSubmodule: boolean
+  submodulePaths: string[]
 }): Promise<void> => {
   let recoverableDeletedFiles = deletedFiles
   core.debug(`recoverable deleted files: ${recoverableDeletedFiles}`)
@@ -1353,19 +1451,64 @@ export const recoverDeletedFiles = async ({
       )
     }
 
-    const deletedFileContents = await getDeletedFileContents({
-      cwd: workingDirectory,
-      filePath: deletedFile,
-      sha
-    })
+    let deletedFileContents: string
+
+    const submodulePath = submodulePaths.find(p => deletedFile.startsWith(p))
+
+    if (hasSubmodule && submodulePath) {
+      const submoduleShaResult = await gitSubmoduleDiffSHA({
+        cwd: workingDirectory,
+        parentSha1: diffResult.previousSha,
+        parentSha2: diffResult.currentSha,
+        submodulePath,
+        diff: diffResult.diff
+      })
+
+      if (submoduleShaResult.previousSha) {
+        core.debug(
+          `recovering deleted file "${deletedFile}" from submodule ${submodulePath} from ${submoduleShaResult.previousSha}`
+        )
+        deletedFileContents = await getDeletedFileContents({
+          cwd: path.join(workingDirectory, submodulePath),
+          // E.g. submodulePath = test/demo and deletedFile = test/demo/.github/README.md => filePath => .github/README.md
+          filePath: deletedFile.replace(submodulePath, '').substring(1),
+          sha: submoduleShaResult.previousSha
+        })
+      } else {
+        core.warning(
+          `Unable to recover deleted file "${deletedFile}" from submodule ${submodulePath} from ${submoduleShaResult.previousSha}`
+        )
+        continue
+      }
+    } else {
+      core.debug(
+        `recovering deleted file "${deletedFile}" from ${diffResult.previousSha}`
+      )
+      deletedFileContents = await getDeletedFileContents({
+        cwd: workingDirectory,
+        filePath: deletedFile,
+        sha: diffResult.previousSha
+      })
+    }
+
+    core.debug(`recovered deleted file "${deletedFile}"`)
 
     if (!(await exists(path.dirname(target)))) {
+      core.debug(`creating directory "${path.dirname(target)}"`)
       await fs.mkdir(path.dirname(target), {recursive: true})
     }
+    core.debug(`writing file "${target}"`)
     await fs.writeFile(target, deletedFileContents)
+    core.debug(`wrote file "${target}"`)
   }
 }
 
+/**
+ * Determines whether the specified working directory has a local Git directory.
+ *
+ * @param workingDirectory - The path of the working directory.
+ * @returns A boolean value indicating whether the working directory has a local Git directory.
+ */
 export const hasLocalGitDirectory = async ({
   workingDirectory
 }: {
@@ -1375,3 +1518,33 @@ export const hasLocalGitDirectory = async ({
     cwd: workingDirectory
   })
 }
+
+/**
+ * Warns about unsupported inputs when using the REST API.
+ *
+ * @param inputs - The inputs object.
+ */
+export const warnUnsupportedRESTAPIInputs = async ({
+  inputs
+}: {
+  inputs: Inputs
+}): Promise<void> => {
+  for (const key of Object.keys(DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS)) {
+    const defaultValue = Object.hasOwnProperty.call(
+      DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS,
+      key
+    )
+      ? DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[
+          key as keyof Inputs
+        ]?.toString()
+      : ''
+
+    if (defaultValue !== inputs[key as keyof Inputs]?.toString()) {
+      core.warning(
+        `Input "${snakeCase(
+          key
+        )}" is not supported when using GitHub's REST API to get changed files`
+      )
+    }
+  }
+}