chore(deps): update dependency @types/node to v20.11.5

Co-authored-by: GitHub Action <action@github.com>

.all-contributorsrc

@@ -197,6 +197,17 @@
         "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"
+      ]
     }
   ],
   "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,6 +17,11 @@ 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
@@ -51,6 +56,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/issue-comment-test.yml

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

.github/workflows/manual-test.yml

@@ -1,5 +1,8 @@
 name: Manual Test
 
+permissions:
+   contents: read
+
 on:
   workflow_dispatch:
 

.github/workflows/matrix-test.yml

@@ -1,5 +1,8 @@
 name: Matrix Test
 
+permissions:
+   contents: read
+
 on:
   workflow_dispatch:
   pull_request:
@@ -22,7 +25,6 @@ jobs:
         uses: ./
         with:
           json: true
-          quotepath: false
           escape_json: false
       - name: List all changed files
         run: echo '${{ steps.changed-files.outputs.all_changed_files }}'

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

@@ -0,0 +1,67 @@
+name: Multi Job Test
+
+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]

.github/workflows/test.yml

@@ -1,5 +1,9 @@
 name: CI
 
+permissions:
+  contents: read
+  pull-requests: write
+
 on:
   push:
     branches:
@@ -24,7 +28,7 @@ on:
       - auto_merge_enabled
       - auto_merge_disabled
     branches:
-      - main
+      - "**"
 
 jobs:
   build:
@@ -39,7 +43,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.1
         with:
           cache: 'yarn'
           node-version: '20.x'
@@ -54,7 +58,7 @@ jobs:
           yarn install
 
       - name: Run eslint on changed files
-        uses: tj-actions/eslint-changed-files@v21
+        uses: tj-actions/eslint-changed-files@v22
         if: github.event_name == 'pull_request'
         with:
           token: ${{ secrets.PAT_TOKEN }}
@@ -66,7 +70,7 @@ jobs:
           yarn all
 
       - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v16
+        uses: tj-actions/verify-changed-files@v17
         id: changed_files
         with:
           files: |
@@ -824,6 +828,36 @@ 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
@@ -1953,7 +1987,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:
@@ -23,7 +27,7 @@ jobs:
         uses: tj-actions/remark@v3
 
       - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v16
+        uses: tj-actions/verify-changed-files@v17
         id: verify_changed_files
         with:
           files: |

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

@@ -0,0 +1,20 @@
+name: Workflow Run Example
+on:
+  workflow_run:
+    workflows: [Matrix Test]
+    types: [completed]
+
+permissions:
+  contents: read
+
+jobs:
+  on-success:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - run: echo 'The triggering workflow passed'
+  on-failure:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - run: echo 'The triggering workflow failed'

HISTORY.md

@@ -1,5 +1,283 @@
 # Changelog
 
+# [41.1.1](https://github.com/tj-actions/changed-files/compare/v41.1.0...v41.1.1) - (2024-01-13)
+
+## <!-- 1 -->🐛 Bug Fixes
+
+- Bug with inaccurate warnings ([#1853](https://github.com/tj-actions/changed-files/issues/1853)) ([62f4729](https://github.com/tj-actions/changed-files/commit/62f4729b5df35e6e0e01265fa70a82ccaf196b4b))  - (Tonye Jack)
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v41.1.0 ([#1852](https://github.com/tj-actions/changed-files/issues/1852))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([e0579ab](https://github.com/tj-actions/changed-files/commit/e0579abf95abec8042468976c7822e6867542199))  - (tj-actions[bot])
+
+# [41.1.0](https://github.com/tj-actions/changed-files/compare/v41.0.1...v41.1.0) - (2024-01-13)
+
+## <!-- 0 -->🚀 Features
+
+- Add support for forcing the use of GitHub’s REST API ([#1849](https://github.com/tj-actions/changed-files/issues/1849)) ([0ca1c07](https://github.com/tj-actions/changed-files/commit/0ca1c07b47b66abe421382a891da70a506e60e8a))  - (Tonye Jack)
+
+## <!-- 1 -->🐛 Bug Fixes
+
+- Permission with release workflow ([#1851](https://github.com/tj-actions/changed-files/issues/1851)) ([8e0194b](https://github.com/tj-actions/changed-files/commit/8e0194b29bc4bb6dd2338b6b7b915c56c2df6f58))  - (Tonye Jack)
+
+## <!-- 26 -->🔄 Update
+
+- Updated README.md ([#1850](https://github.com/tj-actions/changed-files/issues/1850))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([3649d28](https://github.com/tj-actions/changed-files/commit/3649d2842d46e7cc679c204d917887f7821cf08a))  - (tj-actions[bot])
+- Updated README.md ([#1830](https://github.com/tj-actions/changed-files/issues/1830))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([3fbf5fb](https://github.com/tj-actions/changed-files/commit/3fbf5fb588c7e1fdbc140668150a2b725984c6ed))  - (tj-actions[bot])
+- Update README.md ([9523067](https://github.com/tj-actions/changed-files/commit/95230678db8c15d57cd678fbcd2a7e87e83ac1e1))  - (Tonye Jack)
+- Update README.md ([032add1](https://github.com/tj-actions/changed-files/commit/032add13e8e88878dc3238258baee58dcb4a528a))  - (Tonye Jack)
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- Update top level workflow permissions ([#1848](https://github.com/tj-actions/changed-files/issues/1848)) ([a57f4dc](https://github.com/tj-actions/changed-files/commit/a57f4dcc814fa55691c9ee5fc6e07c7487cb69f1))  - (Tonye Jack)
+- **deps:** Update dependency prettier to v3.2.1 ([9c39b0b](https://github.com/tj-actions/changed-files/commit/9c39b0b6e9d3a1e534a35da2e6142c8b1d0204b3))  - (renovate[bot])
+- **deps:** Update dependency eslint-plugin-jest to v27.6.3 ([8b141f3](https://github.com/tj-actions/changed-files/commit/8b141f390680a108c54963421dbc9ed587516859))  - (renovate[bot])
+- Create multi-job-test.yml ([#1843](https://github.com/tj-actions/changed-files/issues/1843)) ([17e07d8](https://github.com/tj-actions/changed-files/commit/17e07d8bc032c41929a28e4ac0180f5fd41e62e8))  - (Tonye Jack)
+- Update warning message ([#1845](https://github.com/tj-actions/changed-files/issues/1845)) ([13fa1c0](https://github.com/tj-actions/changed-files/commit/13fa1c06fc72cd769f43877df4deb2fcef0070bf))  - (Tonye Jack)
+- **deps:** Update dependency prettier to v3.2.0 ([0deb29d](https://github.com/tj-actions/changed-files/commit/0deb29d192a79307172c8ca2af53b9163e1f2dce))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.11.0 ([28267ee](https://github.com/tj-actions/changed-files/commit/28267ee8b7e9d0a1510577b3da5c95991e566f8d))  - (renovate[bot])
+- **deps:** Update dependency eslint-plugin-jest to v27.6.2 ([094d344](https://github.com/tj-actions/changed-files/commit/094d3441f851cdd60b3184c559065cff58998103))  - (renovate[bot])
+- **deps:** Update dependency eslint-plugin-prettier to v5.1.3 ([aeec36b](https://github.com/tj-actions/changed-files/commit/aeec36b0354dca21f43136a2a5be79815ad013b9))  - (renovate[bot])
+- **deps-dev:** Bump @types/node from 20.10.7 to 20.10.8 ([#1836](https://github.com/tj-actions/changed-files/issues/1836)) ([2d0270c](https://github.com/tj-actions/changed-files/commit/2d0270c489bf57145dd4a63d0a5fcf35a7147bc3))  - (dependabot[bot])
+- **deps:** Update typescript-eslint monorepo to v6.18.1 ([0e0adfa](https://github.com/tj-actions/changed-files/commit/0e0adfa0d3cc3663f8db2d833bbec96034e98250))  - (renovate[bot])
+- Update jest.config.js ([#1834](https://github.com/tj-actions/changed-files/issues/1834)) ([5313e6b](https://github.com/tj-actions/changed-files/commit/5313e6bbe36db02444adb6db8803c3fb020fbeef))  - (Tonye Jack)
+- **deps:** Lock file maintenance ([54789be](https://github.com/tj-actions/changed-files/commit/54789be3a182749c98b3750327225ef16ae72b85))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.10.7 ([1675238](https://github.com/tj-actions/changed-files/commit/1675238cfd53ec058721786adb67a77f56f46987))  - (renovate[bot])
+- Create workflow-run-test.yml ([#1828](https://github.com/tj-actions/changed-files/issues/1828)) ([fdccafb](https://github.com/tj-actions/changed-files/commit/fdccafbb6e5c278dc3360f8a44f7c2878206751f))  - (Tonye Jack)
+- **deps:** Update typescript-eslint monorepo to v6.18.0 ([0e8d796](https://github.com/tj-actions/changed-files/commit/0e8d796ee02804f613950c68e90685e43f22c9d5))  - (renovate[bot])
+- **deps:** Update dependency eslint-plugin-jest to v27.6.1 ([0c6f2ac](https://github.com/tj-actions/changed-files/commit/0c6f2ac4885216b1830ecbcc3573209980c97716))  - (renovate[bot])
+- **deps:** Update typescript-eslint monorepo to v6.17.0 ([1db97ad](https://github.com/tj-actions/changed-files/commit/1db97adba438afdc3741c78fd02aa2ac621332b0))  - (renovate[bot])
+- **deps:** Lock file maintenance ([fb8f6db](https://github.com/tj-actions/changed-files/commit/fb8f6db383582a9d4ee2fadc1601db53b2fe1c2b))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.10.6 ([efd7ece](https://github.com/tj-actions/changed-files/commit/efd7ecef11e1ce94fc5121243c09ad2be618d175))  - (renovate[bot])
+- **deps:** Update tj-actions/verify-changed-files action to v17 ([#1820](https://github.com/tj-actions/changed-files/issues/1820)) ([4f8e12c](https://github.com/tj-actions/changed-files/commit/4f8e12c0984394b03e7c4015292f8f644e2e5426))  - (renovate[bot])
+- **deps:** Update typescript-eslint monorepo to v6.16.0 ([0f0747e](https://github.com/tj-actions/changed-files/commit/0f0747e79dd8b1e79730cb9aeb9adbc1d45b79da))  - (renovate[bot])
+- Update matrix-test.yml ([#1814](https://github.com/tj-actions/changed-files/issues/1814)) ([0c2a758](https://github.com/tj-actions/changed-files/commit/0c2a758b81c9fe6c9dc0b17f46d87e68707e8054))  - (Tonye Jack)
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v41.0.1 ([#1816](https://github.com/tj-actions/changed-files/issues/1816))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([1b6d7b6](https://github.com/tj-actions/changed-files/commit/1b6d7b6fb62c81ae85b9114bbb15ebeb21c2833d))  - (tj-actions[bot])
+
+# [41.0.1](https://github.com/tj-actions/changed-files/compare/v41.0.0...v41.0.1) - (2023-12-24)
+
+## <!-- 1 -->🐛 Bug Fixes
+
+- Update characters escaped by safe output ([#1815](https://github.com/tj-actions/changed-files/issues/1815)) ([716b1e1](https://github.com/tj-actions/changed-files/commit/716b1e13042866565e00e85fd4ec490e186c4a2f))  - (Tonye Jack)
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- **deps:** Update dependency eslint-plugin-prettier to v5.1.2 ([7aaf10d](https://github.com/tj-actions/changed-files/commit/7aaf10d9eef19e8a2432a967b88124171152caaf))  - (renovate[bot])
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v41 ([#1811](https://github.com/tj-actions/changed-files/issues/1811))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([cc08e17](https://github.com/tj-actions/changed-files/commit/cc08e170f4447237bcaf8acaacfa615b9cb86612))  - (tj-actions[bot])
+
+# [41.0.0](https://github.com/tj-actions/changed-files/compare/v40.2.3...v41.0.0) - (2023-12-23)
+
+## <!-- 1 -->🐛 Bug Fixes
+
+- Update safe output regex and the docs ([#1805](https://github.com/tj-actions/changed-files/issues/1805)) ([ff2f6e6](https://github.com/tj-actions/changed-files/commit/ff2f6e6b91913a7be42be1b5917330fe442f2ede))  - (tj-actions[bot])
+
+## <!-- 11 -->⏪ Reverts
+
+- Revert "chore(deps): update actions/download-artifact action to v4" ([#1806](https://github.com/tj-actions/changed-files/issues/1806))
+
+ ([4f573fe](https://github.com/tj-actions/changed-files/commit/4f573fed06c9abb5da4c72f75c1c320718114ff7))  - (Tonye Jack)
+
+## <!-- 26 -->🔄 Update
+
+- Update README.md ([6e79d6e](https://github.com/tj-actions/changed-files/commit/6e79d6e3dbe48946636c2939c80ff5c84ff7f9fe))  - (Tonye Jack)
+- Update README.md ([d13ac19](https://github.com/tj-actions/changed-files/commit/d13ac1942fb3c1d7d32017915bb082cebe8a272a))  - (Tonye Jack)
+- Update README.md ([bb89f97](https://github.com/tj-actions/changed-files/commit/bb89f97963be96b39e1a303e64d5b91a1af4c340))  - (Tonye Jack)
+- Updated README.md ([#1810](https://github.com/tj-actions/changed-files/issues/1810))
+
+Co-authored-by: renovate[bot] <renovate[bot]@users.noreply.github.com> ([1864078](https://github.com/tj-actions/changed-files/commit/1864078d0afadf68ba489e671ecc09fefe8b70ab))  - (tj-actions[bot])
+- Update README.md ([#1808](https://github.com/tj-actions/changed-files/issues/1808))
+
+ ([47371c5](https://github.com/tj-actions/changed-files/commit/47371c50e97c089212d9eb92ca26c8453224e78e))  - (Tonye Jack)
+
+## <!-- 30 -->📝 Other
+
+- Merge pull request from GHSA-mcph-m25j-8j63
+
+* feat: add `safe_output` input enabled by default
+
+* fix: migrate README to safe uses of interpolation
+
+* fix: README `uses` typo
+
+* fix: README examples to account for newlines
+
+* fix: README examples missing `safe_output`
+
+* fix: remove sanitization of `'`
+
+* fix: also sanitize `|&;` ([0102c07](https://github.com/tj-actions/changed-files/commit/0102c07446a3cad972f4afcbd0ee4dbc4b6d2d1b))  - (Jorge)
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- **deps:** Lock file maintenance ([f495a03](https://github.com/tj-actions/changed-files/commit/f495a0321d3fffa62da2573adf70b77d5eb2f57a))  - (renovate[bot])
+- **deps:** Update dependency eslint-plugin-prettier to v5.1.1 ([089842a](https://github.com/tj-actions/changed-files/commit/089842a7a899531f61a45ef6ea69c485e1d62dbe))  - (renovate[bot])
+- **deps:** Lock file maintenance ([787db06](https://github.com/tj-actions/changed-files/commit/787db0612e783421667a00319cf394b649682c4c))  - (renovate[bot])
+- **deps:** Update dependency eslint-plugin-prettier to v5.1.0 ([4ef6b56](https://github.com/tj-actions/changed-files/commit/4ef6b56482141a958bd3efb05520e4df9ecf4147))  - (renovate[bot])
+- **deps:** Update typescript-eslint monorepo to v6.15.0 ([c9ae347](https://github.com/tj-actions/changed-files/commit/c9ae347dbba64d95d83f36a0568e0e25a688dd1f))  - (renovate[bot])
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v40.2.3 ([#1800](https://github.com/tj-actions/changed-files/issues/1800))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
+Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com> ([f9480db](https://github.com/tj-actions/changed-files/commit/f9480db177263c95588c5d9dae7c78f97d39242a))  - (tj-actions[bot])
+
+# [40.2.3](https://github.com/tj-actions/changed-files/compare/v40.2.2...v40.2.3) - (2023-12-18)
+
+## <!-- 16 -->➕ Add
+
+- Added missing changes and modified dist assets.
+ ([af2816c](https://github.com/tj-actions/changed-files/commit/af2816c65436325c50621100d67f6e853cd1b0f1))  - (GitHub Action)
+
+## <!-- 26 -->🔄 Update
+
+- Update README.md ([35da2a2](https://github.com/tj-actions/changed-files/commit/35da2a2e0191eb945214321cc664869c14bb417d))  - (Tonye Jack)
+- Update README.md ([e7023fa](https://github.com/tj-actions/changed-files/commit/e7023fa1da70371f80732e85962d42429dbb753f))  - (Tonye Jack)
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- **deps:** Update actions/setup-node action to v4.0.1 ([56284d8](https://github.com/tj-actions/changed-files/commit/56284d80811fb5963a972b438f2870f175e5b7c8))  - (renovate[bot])
+- **deps:** Lock file maintenance ([35ad678](https://github.com/tj-actions/changed-files/commit/35ad6787f51ccf58acdbbb0fa3a218043189e04a))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.10.5 ([ca0db0e](https://github.com/tj-actions/changed-files/commit/ca0db0ea03dfadeb55abbfe75f0f2a409c2b63a2))  - (renovate[bot])
+- **deps:** Update dependency eslint to v8.56.0 ([03fcd0b](https://github.com/tj-actions/changed-files/commit/03fcd0b3bbebef7d94f2dd168773ff4cfe07e4a8))  - (renovate[bot])
+- **deps:** Lock file maintenance ([2329d9f](https://github.com/tj-actions/changed-files/commit/2329d9fb48d2d2dec879a4880f6a786dabc3b600))  - (renovate[bot])
+- **deps:** Update actions/download-artifact action to v4 ([#1793](https://github.com/tj-actions/changed-files/issues/1793)) ([154ca89](https://github.com/tj-actions/changed-files/commit/154ca89d2ee4f46393b1d62a52384c81606c56c1))  - (renovate[bot])
+- **deps:** Update github/codeql-action action to v3 ([#1792](https://github.com/tj-actions/changed-files/issues/1792)) ([449352f](https://github.com/tj-actions/changed-files/commit/449352f10e90ac442b572b634237087e2deb2650))  - (renovate[bot])
+- **deps:** Update typescript-eslint monorepo to v6.14.0 ([7c18263](https://github.com/tj-actions/changed-files/commit/7c1826332f68b8fda7e96b7897dda706c8c7ade8))  - (renovate[bot])
+- **deps:** Lock file maintenance ([88be287](https://github.com/tj-actions/changed-files/commit/88be287f562aea237fd7361d4c2af5c75bc4d9aa))  - (renovate[bot])
+- **deps:** Update dependency prettier to v3.1.1 ([5513a5e](https://github.com/tj-actions/changed-files/commit/5513a5e205776f7ce167db86c93107b21826247e))  - (renovate[bot])
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v40.2.2 ([#1787](https://github.com/tj-actions/changed-files/issues/1787))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([46550b6](https://github.com/tj-actions/changed-files/commit/46550b6fd9d874e06d58f846c7f42cc7b84e4aba))  - (tj-actions[bot])
+
+# [40.2.2](https://github.com/tj-actions/changed-files/compare/v40.2.1...v40.2.2) - (2023-12-10)
+
+## <!-- 1 -->🐛 Bug Fixes
+
+- Bug recovering deleted files for submodules ([#1784](https://github.com/tj-actions/changed-files/issues/1784)) ([9454999](https://github.com/tj-actions/changed-files/commit/94549999469dbfa032becf298d95c87a14c34394))  - (Tonye Jack)
+
+## <!-- 17 -->➖ Remove
+
+- Deleted .github/workflows/auto-approve.yml ([a661767](https://github.com/tj-actions/changed-files/commit/a66176714d5d018bc975bf0246c427135def756c))  - (Tonye Jack)
+
+## <!-- 26 -->🔄 Update
+
+- Updated README.md ([#1786](https://github.com/tj-actions/changed-files/issues/1786))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([7611ff3](https://github.com/tj-actions/changed-files/commit/7611ff348df4d0d46887198cda7203e6fc5ffa80))  - (tj-actions[bot])
+- Update README.md ([c116f52](https://github.com/tj-actions/changed-files/commit/c116f52a1566bda08e9782a74c333a21270cf952))  - (Tonye Jack)
+- Updated README.md ([#1779](https://github.com/tj-actions/changed-files/issues/1779))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([0b0b642](https://github.com/tj-actions/changed-files/commit/0b0b6429e1c5a0bc3f85230a0e1f6df2cba44600))  - (tj-actions[bot])
+- Update README.md ([f732c37](https://github.com/tj-actions/changed-files/commit/f732c371a41ace2af86e5cb2e4f7b0254e4a63e5))  - (Tonye Jack)
+- Updated README.md ([#1778](https://github.com/tj-actions/changed-files/issues/1778))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([04c0045](https://github.com/tj-actions/changed-files/commit/04c00459a27a4e6651f4b0fa3d3a4bc500480109))  - (tj-actions[bot])
+- Update README.md ([5cee511](https://github.com/tj-actions/changed-files/commit/5cee511ba525ad1e92208283322b32120a033b48))  - (Tonye Jack)
+- Update README.md ([399525a](https://github.com/tj-actions/changed-files/commit/399525a994a54fef4ac0ef55192e3d2e30dc0587))  - (Tonye Jack)
+- Update README.md ([c075bd2](https://github.com/tj-actions/changed-files/commit/c075bd27195652f012b60452cd3026891de29306))  - (Tonye Jack)
+- Update README.md ([2918913](https://github.com/tj-actions/changed-files/commit/29189133419ced6b335e576b1e1f7a9e8061fdd8))  - (Tonye Jack)
+
+## <!-- 3 -->📚 Documentation
+
+- Add rodrigorfk as a contributor for code, test, and bug ([#1785](https://github.com/tj-actions/changed-files/issues/1785)) ([187cf1e](https://github.com/tj-actions/changed-files/commit/187cf1e88cc94e5b5243c6eefcc550510b7894a8))  - (allcontributors[bot])
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- **deps:** Bump tj-actions/branch-names from 7 to 8 ([#1782](https://github.com/tj-actions/changed-files/issues/1782)) ([e1e532c](https://github.com/tj-actions/changed-files/commit/e1e532cff0353cb6a98b0bce6ff00b7e7d2cc320))  - (dependabot[bot])
+- **deps:** Update dependency @types/node to v20.10.4 ([dfecec4](https://github.com/tj-actions/changed-files/commit/dfecec4fb70c945750762cdad7026ee55d8a205f))  - (renovate[bot])
+- **deps:** Update dependency typescript to v5.3.3 ([208b83f](https://github.com/tj-actions/changed-files/commit/208b83f29576c33f31be8846aadbf644242f2b2f))  - (renovate[bot])
+- **deps-dev:** Bump @types/jest from 29.5.10 to 29.5.11 ([#1775](https://github.com/tj-actions/changed-files/issues/1775)) ([ccb109a](https://github.com/tj-actions/changed-files/commit/ccb109a58449e62280c2ecefb65010f90fbd0e4f))  - (dependabot[bot])
+- Update package.json ([#1774](https://github.com/tj-actions/changed-files/issues/1774)) ([95642a1](https://github.com/tj-actions/changed-files/commit/95642a1ebb79474d514126dd282092c68a08b01b))  - (Tonye Jack)
+- Create SECURITY.md ([#1773](https://github.com/tj-actions/changed-files/issues/1773)) ([726e06f](https://github.com/tj-actions/changed-files/commit/726e06f8efc4737fd4c48080f40a21b4305cafab))  - (Tonye Jack)
+- **deps:** Update typescript-eslint monorepo to v6.13.2 ([d96fe5d](https://github.com/tj-actions/changed-files/commit/d96fe5d9975371a6b58e65d0a309ad49d70e378e))  - (renovate[bot])
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v40.2.1 ([#1771](https://github.com/tj-actions/changed-files/issues/1771))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([4ae611e](https://github.com/tj-actions/changed-files/commit/4ae611e5c56a1c7f3c356adf173f9f11fcca0376))  - (tj-actions[bot])
+
+# [40.2.1](https://github.com/tj-actions/changed-files/compare/v40.2.0...v40.2.1) - (2023-12-04)
+
+## <!-- 16 -->➕ Add
+
+- Added missing changes and modified dist assets.
+ ([1c93849](https://github.com/tj-actions/changed-files/commit/1c938490c880156b746568a518594309cfb3f66b))  - (GitHub Action)
+- Added missing changes and modified dist assets.
+ ([ee5ef75](https://github.com/tj-actions/changed-files/commit/ee5ef758aa548d365981b0889bab497dd108a785))  - (GitHub Action)
+
+## <!-- 17 -->➖ Remove
+
+- Deleted .github/workflows/greetings.yml ([f91c9fe](https://github.com/tj-actions/changed-files/commit/f91c9fe8b1f4719a8e3901b4878b31105efcb66e))  - (Tonye Jack)
+
+## <!-- 26 -->🔄 Update
+
+- Updated README.md ([#1769](https://github.com/tj-actions/changed-files/issues/1769))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([66b77cb](https://github.com/tj-actions/changed-files/commit/66b77cbd0c866511f45c4f624e61034699bc70c2))  - (tj-actions[bot])
+- Update README.md ([10bfa98](https://github.com/tj-actions/changed-files/commit/10bfa980b7876a94d460f54bd1b46d5c54b025d3))  - (Tonye Jack)
+- Updated README.md ([#1767](https://github.com/tj-actions/changed-files/issues/1767))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
+Co-authored-by: Tonye Jack <jtonye@ymail.com> ([9e46b4f](https://github.com/tj-actions/changed-files/commit/9e46b4f7f7dce12301b893ec0484694ae579108d))  - (tj-actions[bot])
+- Update README.md ([3bf6172](https://github.com/tj-actions/changed-files/commit/3bf61725348c8cd85dcf9ce468c35a8e15a5c77e))  - (Tonye Jack)
+- Updated README.md ([#1755](https://github.com/tj-actions/changed-files/issues/1755))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([48427af](https://github.com/tj-actions/changed-files/commit/48427afe26457522a3f0f4a5afae46a8bb6261b1))  - (tj-actions[bot])
+- Update README.md ([742ed36](https://github.com/tj-actions/changed-files/commit/742ed362b6c6415493f2dd3a2e86ccbb60e1035a))  - (Tonye Jack)
+- Updated README.md ([#1750](https://github.com/tj-actions/changed-files/issues/1750))
+
+Co-authored-by: repo-ranger[bot] <repo-ranger[bot]@users.noreply.github.com> ([86cabf5](https://github.com/tj-actions/changed-files/commit/86cabf5ea23ece4cc5468211fbab9fb76f2b1d91))  - (tj-actions[bot])
+
+## <!-- 30 -->📝 Other
+
+- Update test.yml removing pull_request_review event ([#1763](https://github.com/tj-actions/changed-files/issues/1763)) ([af6bdde](https://github.com/tj-actions/changed-files/commit/af6bdde59acc56af0e0a6c6a8acff0d3562162ba))  - (Tonye Jack)
+- Remove usage of pull_request_target event from test.yml ([#1758](https://github.com/tj-actions/changed-files/issues/1758)) ([3ca6b80](https://github.com/tj-actions/changed-files/commit/3ca6b800138b4c660c4b99b76bb064cdf3f31e59))  - (Tonye Jack)
+
+## <!-- 6 -->🧪 Testing
+
+- Verify bug writing outputs when files_yaml is used ([#1762](https://github.com/tj-actions/changed-files/issues/1762)) ([fc1fb2b](https://github.com/tj-actions/changed-files/commit/fc1fb2b582f5e701390f9f6200dddd7425a3cc70))  - (Tonye Jack)
+
+## <!-- 7 -->⚙️ Miscellaneous Tasks
+
+- **deps:** Lock file maintenance ([ba558db](https://github.com/tj-actions/changed-files/commit/ba558db9775398895ee078c784a5ddef602bb754))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.10.3 ([bf19fa2](https://github.com/tj-actions/changed-files/commit/bf19fa23a6b30fb87fe85abdb237154c4573c08c))  - (renovate[bot])
+- **deps:** Update dependency eslint-config-prettier to v9.1.0 ([45581f0](https://github.com/tj-actions/changed-files/commit/45581f0044c213a3f45e5036d921892484eb7a0d))  - (renovate[bot])
+- **deps:** Update dependency eslint to v8.55.0 ([9ebb48b](https://github.com/tj-actions/changed-files/commit/9ebb48b57af1c93015957959d7d9ffe546df3ccd))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.10.2 ([4e2dca3](https://github.com/tj-actions/changed-files/commit/4e2dca3ba527858faa57966af9baff3c9bbbb5d6))  - (renovate[bot])
+- **deps:** Update dependency @types/node to v20.10.1 ([883b4cc](https://github.com/tj-actions/changed-files/commit/883b4ccbdb2f56448769f275a0d599bb9eb942c6))  - (renovate[bot])
+- **deps:** Lock file maintenance ([42fe158](https://github.com/tj-actions/changed-files/commit/42fe158594392b80e30260bbb489eae0ed872e23))  - (renovate[bot])
+- Remove unused job ([#1754](https://github.com/tj-actions/changed-files/issues/1754)) ([5c74583](https://github.com/tj-actions/changed-files/commit/5c74583cb3f4bb017cad62c02cf599b60d088a3d))  - (Tonye Jack)
+- **deps:** Update typescript-eslint monorepo to v6.13.1 ([44d340e](https://github.com/tj-actions/changed-files/commit/44d340e48cef9bee9d0bd468f0f9a8ccf3219200))  - (renovate[bot])
+- **deps:** Update typescript-eslint monorepo to v6.13.0 ([2561448](https://github.com/tj-actions/changed-files/commit/2561448da0579d80e1916a83b9c0d3622add8fc5))  - (renovate[bot])
+- Update README.md ([#1749](https://github.com/tj-actions/changed-files/issues/1749)) ([b5fc67a](https://github.com/tj-actions/changed-files/commit/b5fc67a4f5e5dafd4d564eefde1958a4ae7974ac))  - (Tonye Jack)
+
+## <!-- 9 -->⬆️ Upgrades
+
+- Upgraded to v40.2.0 ([#1746](https://github.com/tj-actions/changed-files/issues/1746))
+
+Co-authored-by: jackton1 <jackton1@users.noreply.github.com> ([0b22a52](https://github.com/tj-actions/changed-files/commit/0b22a52bff23bee090e1e07f70f9e7fab8384387))  - (tj-actions[bot])
+
 # [40.2.0](https://github.com/tj-actions/changed-files/compare/v40.1.1...v40.2.0) - (2023-11-27)
 
 ## <!-- 0 -->🚀 Features

README.md

@@ -3,13 +3,13 @@
 [![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge\&logo=windows\&logoColor=white)](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
 [![Public workflows that use this action.](https://img.shields.io/endpoint?style=for-the-badge\&url=https%3A%2F%2Fused-by.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Dtj-actions%2Fchanged-files%26badge%3Dtrue)](https://github.com/search?o=desc\&q=tj-actions+changed-files+language%3AYAML\&s=\&type=Code)
 
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4a625e9b62794b5b98e169c15c0e673c)](https://www.codacy.com/gh/tj-actions/changed-files/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=tj-actions/changed-files\&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4fe2f49c3ab144b0bbe4effc85a061a0)](https://app.codacy.com/gh/tj-actions/changed-files/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
 [![CI](https://github.com/tj-actions/changed-files/actions/workflows/test.yml/badge.svg)](https://github.com/tj-actions/changed-files/actions/workflows/test.yml)
 [![Update release version.](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml/badge.svg)](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml)
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 
-[![All Contributors](https://img.shields.io/badge/all_contributors-21-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-22-orange.svg?style=flat-square)](#contributors-)
 
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
@@ -19,7 +19,7 @@ Effortlessly track all changed files and directories relative to a target branch
 
 > \[!NOTE]
 >
-> *   This action solely identifies files that have undergone changes within the context of events such as `pull_request*`, `push`, and more. However, it doesn't detect pending uncommitted changes created during the workflow execution.
+> *   This action solely identifies files that have changed within the context of events such as `pull_request*`, `push`, and more. However, it doesn't detect pending uncommitted changes created during the workflow execution.
 >
 >     See: https://github.com/tj-actions/verify-changed-files instead
 
@@ -51,7 +51,7 @@ Effortlessly track all changed files and directories relative to a target branch
 *   Fast execution, averaging 0-10 seconds.
 *   Leverages either [Github's REST API](https://docs.github.com/en/rest/reference/repos#list-commits) or [Git's native diff](https://git-scm.com/docs/git-diff) to determine changed files.
 *   Facilitates easy debugging.
-*   Scales to handle large repositories.
+*   Scales to handle large/mono repositories.
 *   Supports Git submodules.
 *   Supports [merge queues](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue) for pull requests.
 *   Generates escaped [JSON output for running matrix jobs](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml) based on changed files.
@@ -60,7 +60,7 @@ Effortlessly track all changed files and directories relative to a target branch
     *   Optionally excludes the current directory.
 *   Writes outputs to a designated `.txt` or `.json` file for further processing.
 *   Restores deleted files to their previous location or a newly specified location.
-*   Supports Monorepos by fetching a fixed number of commits.
+*   Supports fetching a fixed number of commits which improves performance.
 *   Compatible with all platforms (Linux, MacOS, Windows).
 *   Supports [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners).
 *   Supports [GitHub Enterprise Server](https://docs.github.com/en/enterprise-server@3.3/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server).
@@ -122,43 +122,46 @@ jobs:
       # Example 1
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
-        
         # To compare changes between the current commit and the last pushed remote commit set `since_last_remote_commit: true`. e.g
         # with:
         #   since_last_remote_commit: true 
 
       - name: List all changed files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: |
-          for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
+          for file in "$ALL_CHANGED_FILES"; do
             echo "$file was changed"
           done
 
       # Example 2
       - name: Get all changed markdown files
         id: changed-markdown-files
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
         with:
+          # Avoid using single or double quotes for multiline patterns
           files: |
              **.md
-        # Avoid using single or double quotes for multiline patterns
 
       - name: List all changed files markdown files
+        if: steps.changed-markdown-files.outputs.any_changed == 'true'
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
         run: |
-          for file in ${{ steps.changed-markdown-files.outputs.all_changed_files }}; do
+          for file in "$ALL_CHANGED_FILES"; do
             echo "$file was changed"
           done
 
       # Example 3
       - name: Get all test, doc and src files that have changed
         id: changed-files-yaml
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
         with:
           files_yaml: |
             doc:
               - '**.md'
               - docs/**
-              - README.md
             test:
               - test/**
               - '!test/**.md'
@@ -169,29 +172,35 @@ jobs:
       - name: Run step if test file(s) change
         # NOTE: Ensure all outputs are prefixed by the same key used above e.g. `test_(...)` | `doc_(...)` | `src_(...)` when trying to access the `any_changed` output.
         if: steps.changed-files-yaml.outputs.test_any_changed == 'true'  
+        env:
+          TEST_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.test_all_changed_files }}
         run: |
           echo "One or more test file(s) has changed."
-          echo "List all the files that have changed: ${{ steps.changed-files-yaml.outputs.test_all_changed_files }}"
+          echo "List all the files that have changed: $TEST_ALL_CHANGED_FILES"
       
       - name: Run step if doc file(s) change
         if: steps.changed-files-yaml.outputs.doc_any_changed == 'true'
+        env:
+          DOC_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.doc_all_changed_files }}
         run: |
           echo "One or more doc file(s) has changed."
-          echo "List all the files that have changed: ${{ steps.changed-files-yaml.outputs.doc_all_changed_files }}"
+          echo "List all the files that have changed: $DOC_ALL_CHANGED_FILES"
 
       # Example 3
       - name: Get changed files in the docs folder
         id: changed-files-specific
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
         with:
           files: docs/*.{js,html}  # Alternatively using: `docs/**`
           files_ignore: docs/static.js
 
       - name: Run step if any file(s) in the docs folder change
         if: steps.changed-files-specific.outputs.any_changed == 'true'
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
         run: |
           echo "One or more files in the docs folder has changed."
-          echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}"
+          echo "List all the files that have changed: $ALL_CHANGED_FILES"
 ```
 
 #### Using Github's API :octocat:
@@ -222,11 +231,13 @@ jobs:
     steps:
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
 
       - name: List all changed files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: |
-          for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
+          for file in "$ALL_CHANGED_FILES"; do
             echo "$file was changed"
           done
 ```
@@ -263,13 +274,14 @@ jobs:
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
-
       # NOTE: `since_last_remote_commit: true` is implied by default and falls back to the previous local commit.
 
       - name: List all changed files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: |
-          for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
+          for file in "$ALL_CHANGED_FILES"; do
             echo "$file was changed"
           done
       ...
@@ -296,19 +308,18 @@ Support this project with a :star:
 
 [buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
 
-> \[!WARNING]
+> \[!IMPORTANT]
 >
-> *   When using `files_yaml*` inputs ensure all outputs are prefixed by the key `test_{...}` e.g. `test_added_files`, `test_any_changed`
+> *   When using `files_yaml*` inputs:
-> *   All keys must start with a letter or \_ and contain only alphanumeric characters, -, or \_.
+>     *   All keys must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
-
+>         For example, `test` or `test_key` or `tesT-key` are all valid.
-<!-- AUTO-DOC-OUTPUT:END -->
 
 ## Inputs ⚙️
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
 ```yaml
-- uses: tj-actions/changed-files@v40
+- uses: tj-actions/changed-files@v41
   id: changed-files
   with:
     # Github API URL.
@@ -542,6 +553,12 @@ Support this project with a :star:
     # Default: "\n"
     recover_files_separator: ''
 
+    # Apply sanitization to output filenames before being set as 
+    # output. 
+    # Type: boolean
+    # Default: "true"
+    safe_output: ''
+
     # Split character for output strings.
     # Type: string
     # Default: " "
@@ -585,6 +602,12 @@ Support this project with a :star:
     # Type: string
     until: ''
 
+    # Force the use of Github's REST API even when 
+    # a local copy of the repository exists 
+    # Type: boolean
+    # Default: "false"
+    use_rest_api: ''
+
     # 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`. 
@@ -609,6 +632,13 @@ Support this project with a :star:
 |     U     |   Unmerged   |
 |     X     |   Unknown    |
 
+> \[!IMPORTANT]
+>
+> *   When using `files_yaml*` inputs:
+>     *   it's required to prefix all outputs with the key to ensure that the correct outputs are accessible.
+>
+>         For example, if you use `test` as the key, you can access outputs like `added_files`, `any_changed`, and so on by prefixing them with the key `test_added_files` or `test_any_changed` etc.
+
 ## Outputs 📤
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
@@ -677,7 +707,30 @@ The format of the version string is as follows:
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
+...
+```
+
+</details>
+
+<details>
+<summary>Get all changed files without escaping unsafe filename characters</summary>
+
+```yaml
+...
+    - name: Get changed files
+      id: changed-files
+      uses: tj-actions/changed-files@v41
+      with:
+        safe_output: false # set to false because we are using an environment variable to store the output and avoid command injection.
+
+    - name: List all added files
+      env:
+        ADDED_FILES: ${{ steps.changed-files.outputs.added_files }}
+      run: |
+        for file in "$ADDED_FILES"; do
+          echo "$file was added"
+        done
 ...
 ```
 
@@ -690,7 +743,7 @@ The format of the version string is as follows:
 ...
     - name: Get all changed files and use a comma separator in the output
       id: changed-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         separator: ","
 ...
@@ -707,11 +760,13 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
 
     - name: List all added files
+      env:
+        ADDED_FILES: ${{ steps.changed-files.outputs.added_files }}
       run: |
-        for file in ${{ steps.changed-files.outputs.added_files }}; do
+        for file in "$ADDED_FILES"; do
           echo "$file was added"
         done
 ...
@@ -728,7 +783,7 @@ See [outputs](#outputs) for a list of all available outputs.
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
 
     - name: Run a step if my-file.txt was modified
       if: contains(steps.changed-files.outputs.modified_files, 'my-file.txt')
@@ -749,7 +804,7 @@ See [outputs](#outputs) for a list of all available outputs.
 
    - name: Get changed files and write the outputs to a Txt file
      id: changed-files-write-output-files-txt
-     uses: ./
+     uses: tj-actions/changed-files@v41
      with:
        write_output_files: true
 
@@ -768,7 +823,7 @@ See [outputs](#outputs) for a list of all available outputs.
 ...
    - name: Get changed files and write the outputs to a JSON file
      id: changed-files-write-output-files-json
-     uses: ./
+     uses: tj-actions/changed-files@v41
      with:
        json: true
        write_output_files: true
@@ -788,7 +843,7 @@ See [outputs](#outputs) for a list of all available outputs.
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         files: |
           my-file.txt
@@ -811,7 +866,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files
       id: changed-files-specific
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         files: |
           my-file.txt
@@ -833,15 +888,19 @@ See [inputs](#inputs) for more information.
 
     - name: Run step if any of the listed files above is deleted
       if: steps.changed-files-specific.outputs.any_deleted == 'true'
+      env:
+        DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
       run: |
-        for file in ${{ steps.changed-files-specific.outputs.deleted_files }}; do
+        for file in "$DELETED_FILES"; do
           echo "$file was deleted"
         done
 
     - name: Run step if all listed files above have been deleted
       if: steps.changed-files-specific.outputs.only_deleted == 'true'
+      env:
+        DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
       run: |
-        for file in ${{ steps.changed-files-specific.outputs.deleted_files }}; do
+        for file in "$DELETED_FILES"; do
           echo "$file was deleted"
         done
 ...
@@ -858,7 +917,7 @@ See [outputs](#outputs) for a list of all available outputs.
 ...
     - name: Get changed files using a source file or list of file(s) to populate to files input.
       id: changed-files-specific-source-file
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         files_from_source_file: test/changed-files-list.txt
 ...
@@ -875,7 +934,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files using a source file or list of file(s) to populate to files input and optionally specify more files.
       id: changed-files-specific-source-file-and-specify-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         files_from_source_file: |
           test/changed-files-list.txt
@@ -896,7 +955,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files using a different SHA
       id: changed-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         sha: ${{ github.event.pull_request.head.sha }}
 ...
@@ -913,7 +972,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files using a different base SHA
       id: changed-files
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         base_sha: ${{ github.event.pull_request.base.sha }}
 ...
@@ -945,20 +1004,22 @@ jobs:
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
 
       - name: Get changed files in the .github folder
         id: changed-files-specific
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
         with:
           base_sha: ${{ steps.get-base-sha.outputs.base_sha }}
           files: .github/**
 
       - name: Run step if any file(s) in the .github folder change
         if: steps.changed-files-specific.outputs.any_changed == 'true'
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
         run: |
           echo "One or more files in the .github folder has changed."
-          echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}"
+          echo "List all the files that have changed: $ALL_CHANGED_FILES"
 ...
 ```
 
@@ -979,13 +1040,16 @@ See [inputs](#inputs) for more information.
 
     - name: Run changed-files with defaults in dir1
       id: changed-files-for-dir1
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         path: dir1
 
     - name: List all added files in dir1
+      env:
+        ADDED_FILES: |-
+          ${{ steps.changed-files-for-dir1.outputs.added_files }}
       run: |
-        for file in ${{ steps.changed-files-for-dir1.outputs.added_files }}; do
+        for file in "$ADDED_FILES"; do
           echo "$file was added"
         done
 ...
@@ -1002,13 +1066,13 @@ See [inputs](#inputs) for more information.
 ...
     - name: Run changed-files with quotepath disabled
       id: changed-files-quotepath
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         quotepath: "false"
 
     - name: Run changed-files with quotepath disabled for a specified list of file(s)
       id: changed-files-quotepath-specific
-      uses: ./
+      uses: tj-actions/changed-files@v41
       with:
         files: test/test-è.txt
         quotepath: "false"
@@ -1041,7 +1105,7 @@ See [inputs](#inputs) for more information.
 
       - name: Run changed-files with the commit of the last successful test workflow run
         id: changed-files-base-sha-push
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
         with:
           base_sha: ${{ steps.last_successful_commit_push.outputs.base }}
 ...
@@ -1068,7 +1132,7 @@ See [inputs](#inputs) for more information.
 
       - name: Run changed-files with the commit of the last successful test workflow run on the main branch
         id: changed-files-base-sha-pull-request
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v41
         with:
           base_sha: ${{ steps.last_successful_commit_pull_request.outputs.base }}
 ...
@@ -1094,7 +1158,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Run changed-files with dir_names
       id: changed-files-dir-names
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         dir_names: "true"
 ...
@@ -1111,7 +1175,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Run changed-files with JSON output
       id: changed-files-json
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         json: "true"
 ...
@@ -1128,13 +1192,13 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed-files since 2022-08-19
       id: changed-files-since
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         since: "2022-08-19"
 
     - name: Get changed-files until 2022-08-20
       id: changed-files-until
-      uses: tj-actions/changed-files@v40
+      uses: tj-actions/changed-files@v41
       with:
         until: "2022-08-20"
 ...
@@ -1261,6 +1325,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/albertoperdomo2"><img src="https://avatars.githubusercontent.com/u/62241095?v=4?s=100" width="100px;" alt="Alberto Perdomo"/><br /><sub><b>Alberto Perdomo</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=albertoperdomo2" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://arthurvolant.com"><img src="https://avatars.githubusercontent.com/u/37664438?v=4?s=100" width="100px;" alt="Arthur"/><br /><sub><b>Arthur</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/issues?q=author%3AV0lantis" title="Bug reports">🐛</a> <a href="https://github.com/tj-actions/changed-files/commits?author=V0lantis" title="Code">💻</a></td>
     </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rodrigorfk"><img src="https://avatars.githubusercontent.com/u/1995033?v=4?s=100" width="100px;" alt="Rodrigo Fior Kuntzer"/><br /><sub><b>Rodrigo Fior Kuntzer</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=rodrigorfk" title="Code">💻</a> <a href="https://github.com/tj-actions/changed-files/commits?author=rodrigorfk" title="Tests">⚠️</a> <a href="https://github.com/tj-actions/changed-files/issues?q=author%3Arodrigorfk" title="Bug reports">🐛</a></td>
+    </tr>
   </tbody>
 </table>
 

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

@@ -134,6 +134,10 @@ inputs:
     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."
     required: false
@@ -199,6 +203,10 @@ inputs:
     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

dist/index.js

@@ -157,7 +157,7 @@ const getRenamedFiles = ({ inputs, workingDirectory, hasSubmodule, diffResult, s
                     diff
                 }))) {
                     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);
@@ -199,7 +199,7 @@ var ChangeTypeEnum;
     ChangeTypeEnum["Unmerged"] = "U";
     ChangeTypeEnum["Unknown"] = "X";
 })(ChangeTypeEnum || (exports.ChangeTypeEnum = ChangeTypeEnum = {}));
-const getAllDiffFiles = ({ workingDirectory, hasSubmodule, diffResult, submodulePaths, outputRenamedFilesAsDeletedAndAdded, fetchSubmoduleHistory, failOnInitialDiffError, failOnSubmoduleDiffError }) => __awaiter(void 0, void 0, void 0, function* () {
+const getAllDiffFiles = ({ workingDirectory, hasSubmodule, diffResult, submodulePaths, outputRenamedFilesAsDeletedAndAdded, fetchAdditionalSubmoduleHistory, failOnInitialDiffError, failOnSubmoduleDiffError }) => __awaiter(void 0, void 0, void 0, function* () {
     const files = yield (0, utils_1.getAllChangedFiles)({
         cwd: workingDirectory,
         sha1: diffResult.previousSha,
@@ -227,7 +227,7 @@ const getAllDiffFiles = ({ workingDirectory, hasSubmodule, diffResult, submodule
                     diff
                 }))) {
                     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);
@@ -454,7 +454,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('added_files_count', outputPrefix),
@@ -474,7 +475,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('copied_files_count', outputPrefix),
@@ -494,7 +496,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('modified_files_count', outputPrefix),
@@ -514,7 +517,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('renamed_files_count', outputPrefix),
@@ -534,7 +538,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('type_changed_files_count', outputPrefix),
@@ -554,7 +559,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('unmerged_files_count', outputPrefix),
@@ -574,7 +580,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('unknown_files_count', outputPrefix),
@@ -593,7 +600,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('all_changed_and_modified_files_count', outputPrefix),
@@ -618,7 +626,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('all_changed_files_count', outputPrefix),
@@ -687,7 +696,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('all_modified_files_count', outputPrefix),
@@ -768,7 +778,8 @@ const setOutputsAndGetModifiedAndChangedFilesStatus = ({ allDiffFiles, allFilter
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
     yield (0, utils_1.setOutput)({
         key: (0, utils_1.getOutputKey)('deleted_files_count', outputPrefix),
@@ -970,7 +981,7 @@ const getSHAForNonPullRequestEvent = (inputs, env, workingDirectory, isShallow,
             }
         }
         else {
-            if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+            if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
                 yield (0, utils_1.gitFetchSubmodules)({
                     cwd: workingDirectory,
                     args: [
@@ -1159,7 +1170,7 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
             }
         }
         else {
-            if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+            if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
                 yield (0, utils_1.gitFetchSubmodules)({
                     cwd: workingDirectory,
                     args: [
@@ -1339,6 +1350,39 @@ const getSHAForPullRequestEvent = (inputs, env, workingDirectory, isShallow, has
 exports.getSHAForPullRequestEvent = getSHAForPullRequestEvent;
 
 
+/***/ }),
+
+/***/ 2363:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.UNSUPPORTED_REST_API_INPUTS = void 0;
+exports.UNSUPPORTED_REST_API_INPUTS = [
+    'sha',
+    'baseSha',
+    'since',
+    'until',
+    'path',
+    'quotepath',
+    'diffRelative',
+    'sinceLastRemoteCommit',
+    'recoverDeletedFiles',
+    'recoverDeletedFilesToDestination',
+    'recoverFiles',
+    'recoverFilesSeparator',
+    'recoverFilesIgnore',
+    'recoverFilesIgnoreSeparator',
+    'includeAllOldNewRenamedFiles',
+    'oldNewSeparator',
+    'oldNewFilesSeparator',
+    'skipInitialFetch',
+    'fetchAdditionalSubmoduleHistory',
+    'dirNamesDeletedFilesIncludeOnlyDeletedDirs'
+];
+
+
 /***/ }),
 
 /***/ 9763:
@@ -1480,7 +1524,7 @@ const getInputs = () => {
     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', {
@@ -1498,6 +1542,7 @@ const getInputs = () => {
     });
     const json = core.getBooleanInput('json', { required: false });
     const escapeJson = core.getBooleanInput('escape_json', { required: 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', { required: false });
     const writeOutputFiles = core.getBooleanInput('write_output_files', {
@@ -1526,7 +1571,7 @@ const getInputs = () => {
     const skipInitialFetch = core.getBooleanInput('skip_initial_fetch', {
         required: false
     });
-    const fetchSubmoduleHistory = core.getBooleanInput('fetch_additional_submodule_history', {
+    const fetchAdditionalSubmoduleHistory = core.getBooleanInput('fetch_additional_submodule_history', {
         required: false
     });
     const failOnInitialDiffError = core.getBooleanInput('fail_on_initial_diff_error', {
@@ -1541,6 +1586,9 @@ const getInputs = () => {
     const negationPatternsFirst = core.getBooleanInput('negation_patterns_first', {
         required: false
     });
+    const useRestApi = core.getBooleanInput('use_rest_api', {
+        required: false
+    });
     const inputs = {
         files,
         filesSeparator,
@@ -1565,7 +1613,7 @@ const getInputs = () => {
         since,
         until,
         path,
-        quotePath,
+        quotepath,
         diffRelative,
         sinceLastRemoteCommit,
         recoverDeletedFiles,
@@ -1578,7 +1626,7 @@ const getInputs = () => {
         oldNewSeparator,
         oldNewFilesSeparator,
         skipInitialFetch,
-        fetchSubmoduleHistory,
+        fetchAdditionalSubmoduleHistory,
         dirNamesDeletedFilesIncludeOnlyDeletedDirs,
         // End Not Supported via REST API
         dirNames,
@@ -1587,12 +1635,14 @@ const getInputs = () => {
         dirNamesIncludeFilesSeparator,
         json,
         escapeJson,
+        safeOutput,
         writeOutputFiles,
         outputDir,
         outputRenamedFilesAsDeletedAndAdded,
         token,
         apiUrl,
-        negationPatternsFirst
+        negationPatternsFirst,
+        useRestApi
     };
     if (fetchDepth) {
         inputs.fetchDepth = Math.max(parseInt(fetchDepth, 10), 2);
@@ -1660,13 +1710,13 @@ const utils_1 = __nccwpck_require__(918);
 const getChangedFilesFromLocalGitHistory = ({ inputs, env, workingDirectory, filePatterns, yamlFilePatterns }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c;
     yield (0, utils_1.verifyMinimumGitVersion)();
-    let quotePathValue = 'on';
+    let quotepathValue = 'on';
-    if (!inputs.quotePath) {
+    if (!inputs.quotepath) {
-        quotePathValue = 'off';
+        quotepathValue = 'off';
     }
     yield (0, utils_1.updateGitGlobalConfig)({
         name: 'core.quotepath',
-        value: quotePathValue
+        value: quotepathValue
     });
     if (inputs.diffRelative) {
         yield (0, utils_1.updateGitGlobalConfig)({
@@ -1707,7 +1757,7 @@ const getChangedFilesFromLocalGitHistory = ({ inputs, env, workingDirectory, fil
         diffResult,
         submodulePaths,
         outputRenamedFilesAsDeletedAndAdded,
-        fetchSubmoduleHistory: inputs.fetchSubmoduleHistory,
+        fetchAdditionalSubmoduleHistory: inputs.fetchAdditionalSubmoduleHistory,
         failOnInitialDiffError: inputs.failOnInitialDiffError,
         failOnSubmoduleDiffError: inputs.failOnSubmoduleDiffError
     });
@@ -1725,7 +1775,9 @@ const getChangedFilesFromLocalGitHistory = ({ inputs, env, workingDirectory, fil
             workingDirectory,
             deletedFiles: allDiffFiles[changedFiles_1.ChangeTypeEnum.Deleted],
             recoverPatterns,
-            sha: diffResult.previousSha
+            diffResult,
+            hasSubmodule,
+            submodulePaths
         });
     }
     yield (0, changedFiles_1.processChangedFiles)({
@@ -1750,7 +1802,8 @@ const getChangedFilesFromLocalGitHistory = ({ inputs, env, workingDirectory, fil
             value: allOldNewRenamedFiles.paths,
             writeOutputFiles: inputs.writeOutputFiles,
             outputDir: inputs.outputDir,
-            json: inputs.json
+            json: inputs.json,
+            safeOutput: inputs.safeOutput
         });
         yield (0, utils_1.setOutput)({
             key: 'all_old_new_renamed_files_count',
@@ -1777,7 +1830,7 @@ const getChangedFilesFromRESTAPI = ({ inputs, filePatterns, yamlFilePatterns })
     });
 });
 function run() {
-    var _a;
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         core.startGroup('changed-files');
         const env = yield (0, env_1.getEnv)();
@@ -1785,7 +1838,7 @@ function run() {
         const inputs = (0, inputs_1.getInputs)();
         core.debug(`Inputs: ${JSON.stringify(inputs, null, 2)}`);
         core.debug(`Github Context: ${JSON.stringify(github.context, null, 2)}`);
-        const workingDirectory = path_1.default.resolve(env.GITHUB_WORKSPACE || process.cwd(), inputs.path);
+        const workingDirectory = path_1.default.resolve(env.GITHUB_WORKSPACE || process.cwd(), inputs.useRestApi ? '.' : inputs.path);
         core.debug(`Working directory: ${workingDirectory}`);
         const hasGitDirectory = yield (0, utils_1.hasLocalGitDirectory)({ workingDirectory });
         core.debug(`Has git directory: ${hasGitDirectory}`);
@@ -1799,29 +1852,18 @@ function run() {
             workingDirectory
         });
         core.debug(`Yaml file patterns: ${JSON.stringify(yamlFilePatterns)}`);
+        if (inputs.useRestApi && !((_a = github.context.payload.pull_request) === null || _a === void 0 ? void 0 : _a.number)) {
+            throw new Error("Only pull_request* events are supported when using GitHub's REST API.");
+        }
         if (inputs.token &&
-            ((_a = github.context.payload.pull_request) === null || _a === void 0 ? void 0 : _a.number) &&
+            ((_b = github.context.payload.pull_request) === null || _b === void 0 ? void 0 : _b.number) &&
-            !hasGitDirectory) {
+            (!hasGitDirectory || inputs.useRestApi)) {
             core.info("Using GitHub's REST API to get changed files");
-            const unsupportedInputs = [
+            if (process.env.GITHUB_ACTION_PATH) {
-                'sha',
+                yield (0, utils_1.warnUnsupportedRESTAPIInputs)({
-                'baseSha',
+                    actionPath: path_1.default.join(process.env.GITHUB_ACTION_PATH, 'action.yml'),
-                'since',
+                    inputs
-                '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`);
-                }
             }
             yield getChangedFilesFromRESTAPI({
                 inputs,
@@ -1831,8 +1873,8 @@ function run() {
         }
         else {
             if (!hasGitDirectory) {
-                core.setFailed("Can't find local .git directory. Please run actions/checkout before this action");
+                core.info(`Running on a ${github.context.eventName} event...`);
-                return;
+                throw new Error(`Can't find local .git in ${workingDirectory} directory. Please run actions/checkout before this action (Make sure the 'path' input is correct). If you intend to use Github's REST API note that only pull_request* events are supported.`);
             }
             core.info('Using local .git directory');
             yield getChangedFilesFromLocalGitHistory({
@@ -1851,6 +1893,7 @@ if (!process.env.TESTING) {
     // eslint-disable-next-line github/no-then
     run().catch(e => {
         core.setFailed(e.message || e);
+        process.exit(1);
     });
 }
 
@@ -1918,19 +1961,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.hasLocalGitDirectory = exports.recoverDeletedFiles = exports.setOutput = exports.setArrayOutput = exports.getOutputKey = exports.getRecoverFilePatterns = exports.getYamlFilePatterns = exports.getFilePatterns = exports.getDirNamesIncludeFilesPattern = exports.jsonOutput = exports.getDirnameMaxDepth = exports.canDiffCommits = exports.getPreviousGitTag = exports.cleanShaInput = exports.verifyCommitSha = exports.getParentSha = exports.getCurrentBranchName = exports.getRemoteBranchHeadSha = exports.isInsideWorkTree = exports.getHeadSha = exports.gitLog = exports.getFilteredChangedFiles = exports.getAllChangedFiles = exports.gitRenamedFiles = exports.gitSubmoduleDiffSHA = exports.getSubmodulePath = exports.gitFetchSubmodules = exports.gitFetch = exports.submoduleExists = exports.isRepoShallow = exports.updateGitGlobalConfig = exports.exists = exports.verifyMinimumGitVersion = exports.getDirname = exports.normalizeSeparators = exports.isWindows = void 0;
+exports.warnUnsupportedRESTAPIInputs = exports.hasLocalGitDirectory = exports.recoverDeletedFiles = exports.setOutput = exports.setArrayOutput = exports.getOutputKey = exports.getRecoverFilePatterns = exports.getYamlFilePatterns = exports.getFilePatterns = exports.getDirNamesIncludeFilesPattern = exports.jsonOutput = exports.getDirnameMaxDepth = exports.canDiffCommits = exports.getPreviousGitTag = exports.cleanShaInput = exports.verifyCommitSha = exports.getParentSha = exports.getCurrentBranchName = exports.getRemoteBranchHeadSha = exports.isInsideWorkTree = exports.getHeadSha = exports.gitLog = exports.getFilteredChangedFiles = exports.getAllChangedFiles = exports.gitRenamedFiles = exports.gitSubmoduleDiffSHA = exports.getSubmodulePath = exports.gitFetchSubmodules = exports.gitFetch = exports.submoduleExists = exports.isRepoShallow = exports.updateGitGlobalConfig = exports.exists = exports.verifyMinimumGitVersion = exports.getDirname = exports.normalizeSeparators = exports.isWindows = void 0;
 /*global AsyncIterableIterator*/
 const core = __importStar(__nccwpck_require__(2186));
 const exec = __importStar(__nccwpck_require__(1514));
 const github = __importStar(__nccwpck_require__(5438));
 const fs_1 = __nccwpck_require__(7147);
-const promises_1 = __nccwpck_require__(3292);
 const lodash_1 = __nccwpck_require__(250);
 const micromatch_1 = __importDefault(__nccwpck_require__(6228));
 const path = __importStar(__nccwpck_require__(1017));
 const readline_1 = __nccwpck_require__(4521);
 const yaml_1 = __nccwpck_require__(4083);
 const changedFiles_1 = __nccwpck_require__(7358);
+const constant_1 = __nccwpck_require__(2363);
 const MINIMUM_GIT_VERSION = '2.18.0';
 const isWindows = () => {
     return process.platform === 'win32';
@@ -2171,6 +2214,7 @@ exports.submoduleExists = submoduleExists;
  * Fetches the git repository
  * @param args - arguments for fetch command
  * @param cwd - working directory
+ * @returns exit code
  */
 const gitFetch = ({ args, cwd }) => __awaiter(void 0, void 0, void 0, function* () {
     const { exitCode } = yield exec.getExecOutput('git', ['fetch', '-q', ...args], {
@@ -2201,6 +2245,7 @@ exports.gitFetchSubmodules = gitFetchSubmodules;
 /**
  * Retrieves all the submodule paths
  * @param cwd - working directory
+ * @returns submodule paths
  */
 const getSubmodulePath = ({ cwd }) => __awaiter(void 0, void 0, void 0, function* () {
     const { exitCode, stdout, stderr } = yield exec.getExecOutput('git', ['submodule', 'status'], {
@@ -2225,6 +2270,7 @@ exports.getSubmodulePath = getSubmodulePath;
  * @param parentSha2 - parent commit sha
  * @param submodulePath - path of submodule
  * @param diff - diff type between parent commits (`..` or `...`)
+ * @returns commit sha of submodule
  */
 const gitSubmoduleDiffSHA = ({ cwd, parentSha1, parentSha2, submodulePath, diff }) => __awaiter(void 0, void 0, void 0, function* () {
     var _h, _j, _k, _l;
@@ -2666,7 +2712,7 @@ const getYamlFilePatternsFromContents = ({ content = '', filePath = '', excluded
             core.error(`File does not exist: ${filePath}`);
             throw new Error(`File does not exist: ${filePath}`);
         }
-        source = yield (0, promises_1.readFile)(filePath, 'utf8');
+        source = yield fs_1.promises.readFile(filePath, 'utf8');
     }
     else {
         source = content;
@@ -2798,11 +2844,12 @@ const setArrayOutput = ({ key, inputs, value, outputPrefix }) => __awaiter(void
         writeOutputFiles: inputs.writeOutputFiles,
         outputDir: inputs.outputDir,
         json: inputs.json,
-        shouldEscape: inputs.escapeJson
+        shouldEscape: inputs.escapeJson,
+        safeOutput: inputs.safeOutput
     });
 });
 exports.setArrayOutput = setArrayOutput;
-const setOutput = ({ key, value, writeOutputFiles, outputDir, json = false, shouldEscape = false }) => __awaiter(void 0, void 0, void 0, function* () {
+const setOutput = ({ key, value, writeOutputFiles, outputDir, json = false, shouldEscape = false, safeOutput = false }) => __awaiter(void 0, void 0, void 0, function* () {
     let cleanedValue;
     if (json) {
         cleanedValue = (0, exports.jsonOutput)({ value, shouldEscape });
@@ -2810,6 +2857,10 @@ const setOutput = ({ key, value, writeOutputFiles, outputDir, json = false, shou
     else {
         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) {
         const extension = json ? 'json' : 'txt';
@@ -2832,7 +2883,7 @@ const getDeletedFileContents = ({ cwd, filePath, sha }) => __awaiter(void 0, voi
     }
     return stdout;
 });
-const recoverDeletedFiles = ({ inputs, workingDirectory, deletedFiles, recoverPatterns, sha }) => __awaiter(void 0, void 0, void 0, function* () {
+const recoverDeletedFiles = ({ inputs, workingDirectory, deletedFiles, recoverPatterns, diffResult, hasSubmodule, submodulePaths }) => __awaiter(void 0, void 0, void 0, function* () {
     let recoverableDeletedFiles = deletedFiles;
     core.debug(`recoverable deleted files: ${recoverableDeletedFiles}`);
     if (recoverPatterns.length > 0) {
@@ -2848,24 +2899,90 @@ const recoverDeletedFiles = ({ inputs, workingDirectory, deletedFiles, recoverPa
         if (inputs.recoverDeletedFilesToDestination) {
             target = path.join(workingDirectory, inputs.recoverDeletedFilesToDestination, deletedFile);
         }
-        const deletedFileContents = yield getDeletedFileContents({
+        let deletedFileContents;
-            cwd: workingDirectory,
+        const submodulePath = submodulePaths.find(p => deletedFile.startsWith(p));
-            filePath: deletedFile,
+        if (hasSubmodule && submodulePath) {
-            sha
+            const submoduleShaResult = yield (0, exports.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 = yield 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 = yield getDeletedFileContents({
+                cwd: workingDirectory,
+                filePath: deletedFile,
+                sha: diffResult.previousSha
+            });
+        }
+        core.debug(`recovered deleted file "${deletedFile}"`);
         if (!(yield (0, exports.exists)(path.dirname(target)))) {
+            core.debug(`creating directory "${path.dirname(target)}"`);
             yield fs_1.promises.mkdir(path.dirname(target), { recursive: true });
         }
+        core.debug(`writing file "${target}"`);
         yield fs_1.promises.writeFile(target, deletedFileContents);
+        core.debug(`wrote file "${target}"`);
     }
 });
 exports.recoverDeletedFiles = recoverDeletedFiles;
+/**
+ * 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.
+ */
 const hasLocalGitDirectory = ({ workingDirectory }) => __awaiter(void 0, void 0, void 0, function* () {
     return yield (0, exports.isInsideWorkTree)({
         cwd: workingDirectory
     });
 });
 exports.hasLocalGitDirectory = hasLocalGitDirectory;
+/**
+ * Warns about unsupported inputs when using the REST API.
+ *
+ * @param actionPath - The path to the action file.
+ * @param inputs - The inputs object.
+ */
+const warnUnsupportedRESTAPIInputs = ({ actionPath, inputs }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _m;
+    const actionContents = yield fs_1.promises.readFile(actionPath, 'utf8');
+    const actionYaml = (0, yaml_1.parseDocument)(actionContents, { schema: 'failsafe' });
+    if (actionYaml.errors.length > 0) {
+        throw new Error(`YAML errors in ${actionPath}: ${actionYaml.errors.join(', ')}`);
+    }
+    if (actionYaml.warnings.length > 0) {
+        throw new Error(`YAML warnings in ${actionPath}: ${actionYaml.warnings.join(', ')}`);
+    }
+    const action = actionYaml.toJS();
+    const actionInputs = action.inputs;
+    for (const key of constant_1.UNSUPPORTED_REST_API_INPUTS) {
+        const inputKey = (0, lodash_1.snakeCase)(key);
+        const defaultValue = Object.hasOwnProperty.call(actionInputs[inputKey], 'default')
+            ? actionInputs[inputKey].default.toString()
+            : '';
+        if (defaultValue !== ((_m = inputs[key]) === null || _m === void 0 ? void 0 : _m.toString())) {
+            core.warning(`Input "${inputKey}" is not supported when using GitHub's REST API to get changed files`);
+        }
+    }
+});
+exports.warnUnsupportedRESTAPIInputs = warnUnsupportedRESTAPIInputs;
 
 
 /***/ }),
@@ -7017,7 +7134,7 @@ __export(dist_src_exports, {
 module.exports = __toCommonJS(dist_src_exports);
 
 // pkg/dist-src/version.js
-var VERSION = "9.1.4";
+var VERSION = "9.1.5";
 
 // pkg/dist-src/normalize-paginated-list-response.js
 function normalizePaginatedListResponse(response) {
@@ -54819,14 +54936,6 @@ module.exports = require("fs");
 
 /***/ }),
 
-/***/ 3292:
-/***/ ((module) => {
-
-"use strict";
-module.exports = require("fs/promises");
-
-/***/ }),
-
 /***/ 3685:
 /***/ ((module) => {
 

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": "40.2.0",
+  "version": "41.1.1",
   "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": "prettier --write src/*.ts src/**/*.ts",
-    "format-check": "prettier --check **/*.ts",
+    "format-check": "prettier --check src/*.ts src/**/*.ts",
-    "lint": "eslint **/*.ts --max-warnings 0",
+    "lint": "eslint src/*.ts src/**/*.ts --max-warnings 0",
-    "lint:fix": "eslint --fix src/**/*.ts",
+    "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"

src/__tests__/utils.test.ts

@@ -1,12 +1,18 @@
+import * as core from '@actions/core'
+import {promises as fs} from 'fs'
+import path from 'path'
 import {ChangeTypeEnum} from '../changedFiles'
+import {Inputs} from '../inputs'
 import {
   getDirname,
   getDirnameMaxDepth,
   getFilteredChangedFiles,
-  normalizeSeparators
+  normalizeSeparators,
+  warnUnsupportedRESTAPIInputs
 } from '../utils'
 
 const originalPlatform = process.platform
+const ACTION_PATH = path.resolve(__dirname, '..', '..', 'action.yml')
 
 function mockedPlatform(platform: string): void {
   Object.defineProperty(process, 'platform', {
@@ -575,4 +581,160 @@ 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({
+        actionPath: ACTION_PATH,
+        inputs
+      })
+
+      expect(coreWarningSpy).toHaveBeenCalledWith(
+        'Input "sha" is not supported when using GitHub\'s REST API to get changed files'
+      )
+    })
+
+    // Throws an error if there are YAML errors in the action file.
+    it('should throw an error if there are YAML errors in the action file', async () => {
+      const actionPath = './path/to/action.yml'
+      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
+      }
+
+      // Mocking readFile to return action file contents with errors
+      jest.spyOn(fs, 'readFile').mockResolvedValue(`
+        inputs:
+          files:
+            description: Files
+            required: true
+            default: ""
+          sha:
+            description: SHA
+            required: true
+            default: abc123
+          token:
+            description: Token
+            required: true
+            default: my-token
+        warnings:
+          | Invalid input value`)
+
+      await expect(
+        warnUnsupportedRESTAPIInputs({actionPath, inputs})
+      ).rejects.toThrow(
+        /YAML errors in .\/path\/to\/action.yml: YAMLParseError: Not a YAML token: Invalid input value at line 16, column 13:/
+      )
+    })
+  })
 })

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({
@@ -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({
@@ -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({

src/commitSha.ts

@@ -152,7 +152,7 @@ export const getSHAForNonPullRequestEvent = async (
         })
       }
     } else {
-      if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+      if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -382,7 +382,7 @@ export const getSHAForPullRequestEvent = async (
         }
       }
     } else {
-      if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+      if (hasSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [

src/constant.ts

@@ -0,0 +1,24 @@
+import {Inputs} from './inputs'
+
+export const UNSUPPORTED_REST_API_INPUTS: (keyof Inputs)[] = [
+  'sha',
+  'baseSha',
+  'since',
+  'until',
+  'path',
+  'quotepath',
+  'diffRelative',
+  'sinceLastRemoteCommit',
+  'recoverDeletedFiles',
+  'recoverDeletedFilesToDestination',
+  'recoverFiles',
+  'recoverFilesSeparator',
+  'recoverFilesIgnore',
+  'recoverFilesIgnoreSeparator',
+  'includeAllOldNewRenamedFiles',
+  'oldNewSeparator',
+  'oldNewFilesSeparator',
+  'skipInitialFetch',
+  'fetchAdditionalSubmoduleHistory',
+  'dirNamesDeletedFilesIncludeOnlyDeletedDirs'
+]

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
@@ -52,6 +53,7 @@ export type Inputs = {
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
   negationPatternsFirst: boolean
+  useRestApi: boolean
 }
 
 export const getInputs = (): Inputs => {
@@ -130,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', {
@@ -154,6 +156,7 @@ export const getInputs = (): Inputs => {
   )
   const json = core.getBooleanInput('json', {required: false})
   const escapeJson = core.getBooleanInput('escape_json', {required: 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',
@@ -194,7 +197,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
@@ -226,6 +229,10 @@ export const getInputs = (): Inputs => {
     }
   )
 
+  const useRestApi = core.getBooleanInput('use_rest_api', {
+    required: false
+  })
+
   const inputs: Inputs = {
     files,
     filesSeparator,
@@ -250,7 +257,7 @@ export const getInputs = (): Inputs => {
     since,
     until,
     path,
-    quotePath,
+    quotepath,
     diffRelative,
     sinceLastRemoteCommit,
     recoverDeletedFiles,
@@ -263,7 +270,7 @@ export const getInputs = (): Inputs => {
     oldNewSeparator,
     oldNewFilesSeparator,
     skipInitialFetch,
-    fetchSubmoduleHistory,
+    fetchAdditionalSubmoduleHistory,
     dirNamesDeletedFilesIncludeOnlyDeletedDirs,
     // End Not Supported via REST API
     dirNames,
@@ -272,12 +279,14 @@ export const getInputs = (): Inputs => {
     dirNamesIncludeFilesSeparator,
     json,
     escapeJson,
+    safeOutput,
     writeOutputFiles,
     outputDir,
     outputRenamedFilesAsDeletedAndAdded,
     token,
     apiUrl,
-    negationPatternsFirst
+    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) {
+  if (!inputs.quotepath) {
-    quotePathValue = 'off'
+    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,34 +244,23 @@ 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)[] = [
+    if (process.env.GITHUB_ACTION_PATH) {
-      'sha',
+      await warnUnsupportedRESTAPIInputs({
-      'baseSha',
+        actionPath: path.join(process.env.GITHUB_ACTION_PATH, 'action.yml'),
-      'since',
+        inputs
-      '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 getChangedFilesFromRESTAPI({
       inputs,
@@ -276,10 +269,10 @@ export async function run(): Promise<void> {
     })
   } else {
     if (!hasGitDirectory) {
-      core.setFailed(
+      core.info(`Running on a ${github.context.eventName} event...`)
-        "Can't find local .git directory. Please run actions/checkout before this action"
+      throw new Error(
+        `Can't find local .git in ${workingDirectory} directory. Please run actions/checkout before this action (Make sure the 'path' input is correct). If you intend to use Github's REST API note that only pull_request* events are supported.`
       )
-      return
     }
 
     core.info('Using local .git directory')
@@ -298,5 +291,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

@@ -3,13 +3,14 @@ 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, snakeCase} from 'lodash'
-import {flattenDeep} 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 {UNSUPPORTED_REST_API_INPUTS} from './constant'
 import {Inputs} from './inputs'
 
 const MINIMUM_GIT_VERSION = '2.18.0'
@@ -284,6 +285,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,
@@ -332,6 +334,7 @@ export const gitFetchSubmodules = async ({
 /**
  * Retrieves all the submodule paths
  * @param cwd - working directory
+ * @returns submodule paths
  */
 export const getSubmodulePath = async ({
   cwd
@@ -366,6 +369,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,
@@ -1127,7 +1131,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
   }
@@ -1323,7 +1327,8 @@ export const setArrayOutput = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 }
 
@@ -1333,7 +1338,8 @@ export const setOutput = async ({
   writeOutputFiles,
   outputDir,
   json = false,
-  shouldEscape = false
+  shouldEscape = false,
+  safeOutput = false
 }: {
   key: string
   value: string | string[] | boolean
@@ -1341,6 +1347,7 @@ export const setOutput = async ({
   outputDir: string
   json?: boolean
   shouldEscape?: boolean
+  safeOutput?: boolean
 }): Promise<void> => {
   let cleanedValue
   if (json) {
@@ -1349,6 +1356,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) {
@@ -1395,13 +1407,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}`)
@@ -1426,19 +1442,64 @@ export const recoverDeletedFiles = async ({
       )
     }
 
-    const deletedFileContents = await getDeletedFileContents({
+    let deletedFileContents: string
-      cwd: workingDirectory,
+
-      filePath: deletedFile,
+    const submodulePath = submodulePaths.find(p => deletedFile.startsWith(p))
-      sha
+
-    })
+    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
 }: {
@@ -1448,3 +1509,57 @@ export const hasLocalGitDirectory = async ({
     cwd: workingDirectory
   })
 }
+
+/**
+ * Warns about unsupported inputs when using the REST API.
+ *
+ * @param actionPath - The path to the action file.
+ * @param inputs - The inputs object.
+ */
+export const warnUnsupportedRESTAPIInputs = async ({
+  actionPath,
+  inputs
+}: {
+  actionPath: string
+  inputs: Inputs
+}): Promise<void> => {
+  const actionContents = await fs.readFile(actionPath, 'utf8')
+  const actionYaml = parseDocument(actionContents, {schema: 'failsafe'})
+
+  if (actionYaml.errors.length > 0) {
+    throw new Error(
+      `YAML errors in ${actionPath}: ${actionYaml.errors.join(', ')}`
+    )
+  }
+
+  if (actionYaml.warnings.length > 0) {
+    throw new Error(
+      `YAML warnings in ${actionPath}: ${actionYaml.warnings.join(', ')}`
+    )
+  }
+
+  const action = actionYaml.toJS() as {
+    inputs: {
+      [key: string]: {description: string; required: boolean; default: string}
+    }
+  }
+
+  const actionInputs = action.inputs
+
+  for (const key of UNSUPPORTED_REST_API_INPUTS) {
+    const inputKey = snakeCase(key) as keyof Inputs
+
+    const defaultValue = Object.hasOwnProperty.call(
+      actionInputs[inputKey],
+      'default'
+    )
+      ? actionInputs[inputKey].default.toString()
+      : ''
+
+    if (defaultValue !== inputs[key]?.toString()) {
+      core.warning(
+        `Input "${inputKey}" is not supported when using GitHub's REST API to get changed files`
+      )
+    }
+  }
+}