Updated README.md (#1989)

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

.all-contributorsrc

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

.github/workflows/codacy-analysis.yml

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

.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

.github/workflows/greetings.yml

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

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

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

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

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

.github/workflows/matrix-example.yml

@@ -1,4 +1,7 @@
-name: Matrix Test
+name: Matrix Example
+
+permissions:
+   contents: read
 
 on:
   workflow_dispatch:
@@ -21,9 +24,7 @@ jobs:
         id: changed-files
         uses: ./
         with:
-          json: true
+          matrix: true
-          quotepath: false
-          escape_json: false
       - name: List all changed files
         run: echo '${{ steps.changed-files.outputs.all_changed_files }}'
 

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

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

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

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

.github/workflows/test.yml

@@ -1,5 +1,8 @@
 name: CI
 
+permissions:
+  contents: read
+
 on:
   push:
     branches:
@@ -31,6 +34,9 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       files_changed: ${{ steps.changed_files.outputs.files_changed }}
+    permissions:
+      contents: read
+      pull-requests: write
     steps:
       - uses: actions/checkout@v4
         with:
@@ -39,7 +45,7 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - name: Use Node.js 20.x
-        uses: actions/setup-node@v4.0.1
+        uses: actions/setup-node@v4.0.2
         with:
           cache: 'yarn'
           node-version: '20.x'
@@ -54,7 +60,7 @@ jobs:
           yarn install
 
       - name: Run eslint on changed files
-        uses: tj-actions/eslint-changed-files@v21
+        uses: tj-actions/eslint-changed-files@v23
         if: github.event_name == 'pull_request'
         with:
           token: ${{ secrets.PAT_TOKEN }}
@@ -66,7 +72,7 @@ jobs:
           yarn all
 
       - name: Verify Changed files
-        uses: tj-actions/verify-changed-files@v16
+        uses: tj-actions/verify-changed-files@v19
         id: changed_files
         with:
           files: |
@@ -90,7 +96,7 @@ jobs:
           branch: ${{ github.head_ref }}
 
       - name: Upload build assets
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: build-assets
           path: dist
@@ -107,6 +113,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     steps:
       - name: Checkout into dir1
         uses: actions/checkout@v4
@@ -117,7 +125,7 @@ jobs:
           path: dir1
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
           path: dir1/dist
@@ -143,7 +151,7 @@ jobs:
           bash
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
           path: dir2/dist
@@ -181,7 +189,8 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && needs.build.outputs.files_changed != 'true'
-
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
@@ -190,7 +199,7 @@ jobs:
           fetch-depth: 0
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -239,6 +248,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     steps:
       - name: Checkout branch
@@ -248,7 +259,7 @@ jobs:
           fetch-depth: 0
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -281,6 +292,8 @@ jobs:
         github.event_name == 'push' || 
         github.event_name == 'pull_request'
       ) && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     steps:
       - name: Checkout branch
@@ -290,7 +303,7 @@ jobs:
           fetch-depth: 0
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -311,6 +324,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     strategy:
       fail-fast: false
@@ -327,7 +342,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -350,6 +365,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: github.event_name != 'push' && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
 
     steps:
       - name: Checkout branch
@@ -358,7 +375,7 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -377,6 +394,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: github.event_name != 'push' && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -392,7 +411,7 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -411,13 +430,14 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
-
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -465,13 +485,14 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
-
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -531,7 +552,7 @@ jobs:
           path: dir1
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
           path: dir1/dist
@@ -546,11 +567,83 @@ jobs:
         shell:
           bash
 
+  test-dir-names-nested-folder:
+    name: Test changed-files with dir-names in a nested folder
+    runs-on: ubuntu-latest
+    needs: build
+    if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: true
+          fetch-depth: 0
+
+      - name: Download build assets
+        uses: actions/download-artifact@v4
+        with:
+          name: build-assets
+          path: dist
+
+      - name: Get changed files in the .github folder
+        id: changed-files
+        uses: ./
+        with:
+          path: .github
+          json: true
+          escape_json: false
+          dir_names: true
+          dir_names_exclude_current_dir: true
+
+      - name: Show output
+        run: |
+          echo "${{ toJSON(steps.changed-files.outputs) }}"
+        shell:
+          bash
+
+  test-non-existing-repository:
+    name: Test changed-files with non existing repository
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout into dir1
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: true
+          fetch-depth: 0
+          path: dir1
+
+      - name: Download build assets
+        uses: actions/download-artifact@v4
+        with:
+          name: build-assets
+          path: dir1/dist
+
+      - name: Run changed-files with non existing repository
+        id: changed-files
+        continue-on-error: true
+        uses: ./dir1
+
+      - name: Verify failed
+        if: steps.changed-files.outcome != 'failure'
+        run: |
+          echo "Expected: (failure) got ${{ steps.changed-files.outcome }}"
+          exit 1
+
   test-submodules:
     name: Test changed-files with submodule
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read 
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -566,7 +659,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -594,6 +687,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -609,7 +704,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -669,6 +764,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -684,7 +781,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
 
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -859,6 +956,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
@@ -892,6 +991,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
@@ -933,6 +1034,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -949,7 +1052,7 @@ jobs:
           fetch-depth: ${{ matrix.fetch-depth }}
   
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
 
@@ -983,6 +1086,8 @@ jobs:
     runs-on: ${{ matrix.platform }}
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -998,7 +1103,7 @@ jobs:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           fetch-depth: ${{ matrix.fetch-depth }}
       - name: Download build assets
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-assets
       - name: Dump GitHub context
@@ -1013,7 +1118,7 @@ jobs:
           echo '${{ toJSON(steps.changed-files.outputs) }}'
         shell:
           bash
-      - name: Run changed-files with dir name
+      - name: Run changed-files with dir name pattern
         id: changed-files-dir-name
         uses: ./
         with:

.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@v19
         id: verify_changed_files
         with:
           files: |
@@ -37,7 +41,7 @@ jobs:
 
       - name: Create Pull Request
         if: failure()
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
         with:
           base: "main"
           labels: "merge when passing"

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

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

README.md

@@ -1,25 +1,25 @@
 [![Ubuntu](https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge\&logo=ubuntu\&logoColor=white)](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
 [![Mac OS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge\&logo=macos\&logoColor=F0F0F0)](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
 [![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)
+[![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%26package_id%3DUGFja2FnZS0yOTQyNTU4MDk5%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://app.codacy.com/gh/tj-actions/changed-files/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&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-22-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-26-orange.svg?style=flat-square)](#contributors-)
 
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ## changed-files
 
-Effortlessly track all changed files and directories relative to a target branch, preceding commit or the last remote commit returning **relative paths** from the project root using this GitHub action.
+Effortlessly track all changed files and directories relative to a target branch, the current branch (preceding commit or the last remote commit), multiple branches, or custom commits returning **relative paths** from the project root using this GitHub action.
 
 > \[!NOTE]
 >
-> *   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.
+> *   This action solely identifies files that have changed for events such as [`pull_request*`, `push`, `merge_group`, `release`, and many more](#other-supported-events-electron). However, it doesn't detect pending uncommitted changes created during the workflow execution.
 >
 >     See: https://github.com/tj-actions/verify-changed-files instead
 
@@ -28,7 +28,7 @@ Effortlessly track all changed files and directories relative to a target branch
 *   [Features 🚀](#features-)
 *   [Usage 💻](#usage-)
     *   [On `pull_request` 🔀](#on-pull_request-)
-        *   [Using local .git history 📁](#using-local-git-history-)
+        *   [Using local .git directory 📁](#using-local-git-directory-)
         *   [Using Github's API :octocat:](#using-githubs-api-octocat)
     *   [On `push` ⬆️](#on-push-️)
     *   [Other supported events :electron:](#other-supported-events-electron)
@@ -54,7 +54,7 @@ Effortlessly track all changed files and directories relative to a target branch
 *   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.
+*   Generates escaped [JSON output for running matrix jobs](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml) based on changed files.
 *   Lists changed directories.
     *   Limits matching changed directories to a specified maximum depth.
     *   Optionally excludes the current directory.
@@ -97,7 +97,7 @@ Visit the [discussions for more information](https://github.com/tj-actions/chang
 
 Detect changes to all files in a Pull request relative to the target branch or since the last pushed commit.
 
-#### Using local .git history 📁
+#### Using local .git directory 📁
 
 ```yaml
 name: CI
@@ -119,10 +119,12 @@ jobs:
         with:
           fetch-depth: 0  # OR "2" -> To retrieve the preceding commit.
 
+      # -----------------------------------------------------------------------------------------------------------
       # Example 1
+      # -----------------------------------------------------------------------------------------------------------
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v41
+        uses: tj-actions/changed-files@v42
         # 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 
@@ -131,14 +133,16 @@ jobs:
         env:
           ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: |
-          for file in "$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@v41
+        uses: tj-actions/changed-files@v42
         with:
           # Avoid using single or double quotes for multiline patterns
           files: |
@@ -149,20 +153,21 @@ jobs:
         env:
           ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
         run: |
-          for file in "$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@v41
+        uses: tj-actions/changed-files@v42
         with:
           files_yaml: |
             doc:
               - '**.md'
               - docs/**
-              - README.md
             test:
               - test/**
               - '!test/**.md'
@@ -187,10 +192,12 @@ jobs:
           echo "One or more doc file(s) has changed."
           echo "List all the files that have changed: $DOC_ALL_CHANGED_FILES"
 
-      # Example 3
+      # -----------------------------------------------------------------------------------------------------------
+      # Example 4
+      # -----------------------------------------------------------------------------------------------------------
       - name: Get changed files in the docs folder
         id: changed-files-specific
-        uses: tj-actions/changed-files@v41
+        uses: tj-actions/changed-files@v42
         with:
           files: docs/*.{js,html}  # Alternatively using: `docs/**`
           files_ignore: docs/static.js
@@ -232,13 +239,13 @@ jobs:
     steps:
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v41
+        uses: tj-actions/changed-files@v42
 
       - name: List all changed files
         env:
           ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: |
-          for file in "$ALL_CHANGED_FILES"; do
+          for file in ${ALL_CHANGED_FILES}; do
             echo "$file was changed"
           done
 ```
@@ -275,14 +282,14 @@ jobs:
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v41
+        uses: tj-actions/changed-files@v42
       # 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 "$ALL_CHANGED_FILES"; do
+          for file in ${ALL_CHANGED_FILES}; do
             echo "$file was changed"
           done
       ...
@@ -293,6 +300,7 @@ jobs:
 *   [schedule](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule)
 *   [release](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release)
 *   [workflow\_dispatch](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch)
+*   [workflow\_run](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run)
 *   [merge\_group](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#merge_group)
 *   [issue\_comment](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment)
 *   ...and many more
@@ -313,14 +321,15 @@ Support this project with a :star:
 >
 > *   When using `files_yaml*` inputs:
 >     *   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.
+>
+>         For example, `test` or `test_key` or `test-key` or `_test_key` are all valid.
 
 ## Inputs ⚙️
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
 ```yaml
-- uses: tj-actions/changed-files@v41
+- uses: tj-actions/changed-files@v42
   id: changed-files
   with:
     # Github API URL.
@@ -479,11 +488,18 @@ Support this project with a :star:
 
     # Output list of changed files in a JSON formatted 
     # string which can be used for matrix jobs. Example: 
-    # https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml 
+    # https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml 
     # Type: boolean
     # Default: "false"
     json: ''
 
+    # Output changed files in a format that can be 
+    # used for matrix jobs. Alias for setting inputs `json` 
+    # to `true` and `escape_json` to `false`. 
+    # Type: boolean
+    # Default: "false"
+    matrix: ''
+
     # Apply the negation patterns first. NOTE: This affects how 
     # changed files are matched. 
     # Type: boolean
@@ -584,10 +600,10 @@ Support this project with a :star:
     # Default: "false"
     since_last_remote_commit: ''
 
-    # Skip the initial fetch to improve performance for shallow 
+    # Skip initially fetching additional history to improve performance for 
-    # repositories. NOTE: This could lead to errors with missing 
+    # shallow repositories. NOTE: This could lead to errors with 
-    # history and the intended use is limited to when 
+    # missing history. It's intended to be used when you've 
-    # you've fetched the history necessary to perform the diff. 
+    # fetched all necessary history to perform the diff. 
     # Type: boolean
     # Default: "false"
     skip_initial_fetch: ''
@@ -603,6 +619,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`. 
@@ -650,9 +672,9 @@ Support this project with a :star:
 |                   <a name="output_all_modified_files_count"></a>[all\_modified\_files\_count](#output_all_modified_files_count)                   | string |                                                                                                                                       Returns the number of `all_modified_files`                                                                                                                                        |
 |                 <a name="output_all_old_new_renamed_files"></a>[all\_old\_new\_renamed\_files](#output_all_old_new_renamed_files)                  | string | Returns only files that are <br>Renamed and lists their old <br>and new names. **NOTE:** This <br>requires setting `include_all_old_new_renamed_files` to `true`. <br>Also, keep in mind that <br>this output is global and <br>wouldn't be nested in outputs <br>generated when the `*_yaml_*` input <br>is used. (R)  |
 |        <a name="output_all_old_new_renamed_files_count"></a>[all\_old\_new\_renamed\_files\_count](#output_all_old_new_renamed_files_count)         | string |                                                                                                                                    Returns the number of `all_old_new_renamed_files`                                                                                                                                    |
-|                                      <a name="output_any_changed"></a>[any\_changed](#output_any_changed)                                       | string |                                                     Returns `true` when any of <br>the filenames provided using the <br>`files*` or `files_ignore*` inputs has changed. i.e. <br>*includes a combination of all added, copied, modified and renamed files (ACMR)*.                                                      |
+|                                      <a name="output_any_changed"></a>[any\_changed](#output_any_changed)                                       | string |                      Returns `true` when any of <br>the filenames provided using the <br>`files*` or `files_ignore*` inputs have changed. This <br>defaults to `true` when no <br>patterns are specified. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*.                        |
-|                                      <a name="output_any_deleted"></a>[any\_deleted](#output_any_deleted)                                       | string |                                                                                            Returns `true` when any of <br>the filenames provided using the <br>`files*` or `files_ignore*` inputs has been deleted. <br>(D)                                                                                             |
+|                                      <a name="output_any_deleted"></a>[any\_deleted](#output_any_deleted)                                       | string |                                                             Returns `true` when any of <br>the filenames provided using the <br>`files*` or `files_ignore*` inputs have been deleted. <br>This defaults to `true` when <br>no patterns are specified. (D)                                                               |
-|                                     <a name="output_any_modified"></a>[any\_modified](#output_any_modified)                                     | string |                                            Returns `true` when any of <br>the filenames provided using the <br>`files*` or `files_ignore*` inputs has been modified. <br>i.e. *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*.                                              |
+|                                     <a name="output_any_modified"></a>[any\_modified](#output_any_modified)                                     | string |            Returns `true` when any of <br>the filenames provided using the <br>`files*` or `files_ignore*` inputs have been modified. <br>This defaults to `true` when <br>no patterns are specified. i.e. <br>*includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*.             |
 |                                     <a name="output_changed_keys"></a>[changed\_keys](#output_changed_keys)                                     | string |                                                                     Returns all changed YAML keys <br>when the `files_yaml` input is <br>used. i.e. *key that contains any path that has either been added, copied, modified, and renamed (ACMR)*                                                                       |
 |                                     <a name="output_copied_files"></a>[copied\_files](#output_copied_files)                                     | string |                                                                                                                                      Returns only files that are <br>Copied (C).                                                                                                                                        |
 |                            <a name="output_copied_files_count"></a>[copied\_files\_count](#output_copied_files_count)                            | string |                                                                                                                                          Returns the number of `copied_files`                                                                                                                                           |
@@ -661,9 +683,9 @@ Support this project with a :star:
 |                                  <a name="output_modified_files"></a>[modified\_files](#output_modified_files)                                  | string |                                                                                                                                     Returns only files that are <br>Modified (M).                                                                                                                                       |
 |                         <a name="output_modified_files_count"></a>[modified\_files\_count](#output_modified_files_count)                         | string |                                                                                                                                         Returns the number of `modified_files`                                                                                                                                          |
 |                                   <a name="output_modified_keys"></a>[modified\_keys](#output_modified_keys)                                    | string |                                                                    Returns all modified YAML keys <br>when the `files_yaml` input is <br>used. i.e. *key that contains any path that has either been added, copied, modified, and deleted (ACMRD)*                                                                      |
-|                                     <a name="output_only_changed"></a>[only\_changed](#output_only_changed)                                     | string |                                                            Returns `true` when only files <br>provided using the `files*` or `files_ignore*` inputs <br>has changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*.                                                             |
+|                                     <a name="output_only_changed"></a>[only\_changed](#output_only_changed)                                     | string |                                                           Returns `true` when only files <br>provided using the `files*` or `files_ignore*` inputs <br>have changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*.                                                             |
-|                                     <a name="output_only_deleted"></a>[only\_deleted](#output_only_deleted)                                     | string |                                                                                                   Returns `true` when only files <br>provided using the `files*` or `files_ignore*` inputs <br>has been deleted. (D)                                                                                                    |
+|                                     <a name="output_only_deleted"></a>[only\_deleted](#output_only_deleted)                                     | string |                                                                                                  Returns `true` when only files <br>provided using the `files*` or `files_ignore*` inputs <br>have been deleted. (D)                                                                                                    |
-|                                   <a name="output_only_modified"></a>[only\_modified](#output_only_modified)                                    | string |                                                                                                Returns `true` when only files <br>provided using the `files*` or `files_ignore*` inputs <br>has been modified. (ACMRD).                                                                                                 |
+|                                   <a name="output_only_modified"></a>[only\_modified](#output_only_modified)                                    | string |                                                                                               Returns `true` when only files <br>provided using the `files*` or `files_ignore*` inputs <br>have been modified. (ACMRD).                                                                                                 |
 |                          <a name="output_other_changed_files"></a>[other\_changed\_files](#output_other_changed_files)                           | string |                                                                              Returns all other changed files <br>not listed in the files <br>input i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*.                                                                               |
 |                 <a name="output_other_changed_files_count"></a>[other\_changed\_files\_count](#output_other_changed_files_count)                  | string |                                                                                                                                       Returns the number of `other_changed_files`                                                                                                                                       |
 |                          <a name="output_other_deleted_files"></a>[other\_deleted\_files](#output_other_deleted_files)                           | string |                                                                                                  Returns all other deleted files <br>not listed in the files <br>input i.e. *a  combination of all deleted files (D)*                                                                                                   |
@@ -702,7 +724,7 @@ The format of the version string is as follows:
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
 ...
 ```
 
@@ -715,7 +737,7 @@ The format of the version string is as follows:
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         safe_output: false # set to false because we are using an environment variable to store the output and avoid command injection.
 
@@ -723,7 +745,7 @@ The format of the version string is as follows:
       env:
         ADDED_FILES: ${{ steps.changed-files.outputs.added_files }}
       run: |
-        for file in "$ADDED_FILES"; do
+        for file in ${ADDED_FILES}; do
           echo "$file was added"
         done
 ...
@@ -738,7 +760,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@v41
+      uses: tj-actions/changed-files@v42
       with:
         separator: ","
 ...
@@ -755,13 +777,13 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
 
     - name: List all added files
       env:
         ADDED_FILES: ${{ steps.changed-files.outputs.added_files }}
       run: |
-        for file in "$ADDED_FILES"; do
+        for file in ${ADDED_FILES}; do
           echo "$file was added"
         done
 ...
@@ -778,7 +800,7 @@ See [outputs](#outputs) for a list of all available outputs.
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
 
     - name: Run a step if my-file.txt was modified
       if: contains(steps.changed-files.outputs.modified_files, 'my-file.txt')
@@ -799,7 +821,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: tj-actions/changed-files@v41
+     uses: tj-actions/changed-files@v42
      with:
        write_output_files: true
 
@@ -818,7 +840,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: tj-actions/changed-files@v41
+     uses: tj-actions/changed-files@v42
      with:
        json: true
        write_output_files: true
@@ -838,7 +860,7 @@ See [outputs](#outputs) for a list of all available outputs.
 ...
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         files: |
           my-file.txt
@@ -861,7 +883,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files
       id: changed-files-specific
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         files: |
           my-file.txt
@@ -886,7 +908,7 @@ See [inputs](#inputs) for more information.
       env:
         DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
       run: |
-        for file in "$DELETED_FILES"; do
+        for file in ${DELETED_FILES}; do
           echo "$file was deleted"
         done
 
@@ -895,7 +917,7 @@ See [inputs](#inputs) for more information.
       env:
         DELETED_FILES: ${{ steps.changed-files-specific.outputs.deleted_files }}
       run: |
-        for file in "$DELETED_FILES"; do
+        for file in ${DELETED_FILES}; do
           echo "$file was deleted"
         done
 ...
@@ -912,7 +934,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@v41
+      uses: tj-actions/changed-files@v42
       with:
         files_from_source_file: test/changed-files-list.txt
 ...
@@ -929,7 +951,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@v41
+      uses: tj-actions/changed-files@v42
       with:
         files_from_source_file: |
           test/changed-files-list.txt
@@ -950,7 +972,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files using a different SHA
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         sha: ${{ github.event.pull_request.head.sha }}
 ...
@@ -967,7 +989,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed files using a different base SHA
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         base_sha: ${{ github.event.pull_request.base.sha }}
 ...
@@ -999,13 +1021,18 @@ jobs:
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v41
+        uses: tj-actions/changed-files@v42
+
+      - name: List changed files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
+        run: |
+          echo "List all the files that have changed: $ALL_CHANGED_FILES"
 
       - name: Get changed files in the .github folder
         id: changed-files-specific
-        uses: tj-actions/changed-files@v41
+        uses: tj-actions/changed-files@v42
         with:
-          base_sha: ${{ steps.get-base-sha.outputs.base_sha }}
           files: .github/**
 
       - name: Run step if any file(s) in the .github folder change
@@ -1035,7 +1062,7 @@ See [inputs](#inputs) for more information.
 
     - name: Run changed-files with defaults in dir1
       id: changed-files-for-dir1
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         path: dir1
 
@@ -1044,7 +1071,7 @@ See [inputs](#inputs) for more information.
         ADDED_FILES: |-
           ${{ steps.changed-files-for-dir1.outputs.added_files }}
       run: |
-        for file in "$ADDED_FILES"; do
+        for file in ${ADDED_FILES}; do
           echo "$file was added"
         done
 ...
@@ -1061,13 +1088,13 @@ See [inputs](#inputs) for more information.
 ...
     - name: Run changed-files with quotepath disabled
       id: changed-files-quotepath
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         quotepath: "false"
 
     - name: Run changed-files with quotepath disabled for a specified list of file(s)
       id: changed-files-quotepath-specific
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         files: test/test-è.txt
         quotepath: "false"
@@ -1100,7 +1127,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@v41
+        uses: tj-actions/changed-files@v42
         with:
           base_sha: ${{ steps.last_successful_commit_push.outputs.base }}
 ...
@@ -1127,7 +1154,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@v41
+        uses: tj-actions/changed-files@v42
         with:
           base_sha: ${{ steps.last_successful_commit_pull_request.outputs.base }}
 ...
@@ -1153,7 +1180,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Run changed-files with dir_names
       id: changed-files-dir-names
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         dir_names: "true"
 ...
@@ -1170,7 +1197,7 @@ See [inputs](#inputs) for more information.
 ...
     - name: Run changed-files with JSON output
       id: changed-files-json
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         json: "true"
 ...
@@ -1187,13 +1214,13 @@ See [inputs](#inputs) for more information.
 ...
     - name: Get changed-files since 2022-08-19
       id: changed-files-since
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         since: "2022-08-19"
 
     - name: Get changed-files until 2022-08-20
       id: changed-files-until
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v42
       with:
         until: "2022-08-20"
 ...
@@ -1213,7 +1240,7 @@ See [inputs](#inputs) for more information.
 
 *   [coder/code-server: uses tj-actions/changed-files to automate detecting changes and run steps based on the outcome](https://github.com/coder/code-server/blob/c32a31d802f679846876b8ad9aacff6cf7b5361d/.github/workflows/build.yaml#L48)
 
-*   [tldr-pages/tldr: uses tj-actions/changed-files to automate detecting spelling errors](https://github.com/tldr-pages/tldr/blob/main/.github/workflows/codespell.yml#L14)
+*   [tldr-pages/tldr: uses tj-actions/changed-files to automate detecting spelling errors](https://github.com/tldr-pages/tldr/blob/c1b714c55cb0048037b79a681a10d7f3ddb0164c/.github/workflows/codespell.yml#L18-L26)
 
 *   [nodejs/docker-node: uses tj-actions/changed-files to generate matrix jobs based on changes detected](https://github.com/nodejs/docker-node/blob/3c4fa6daf06a4786d202f2f610351837806a0380/.github/workflows/build-test.yml#L29)
 
@@ -1221,10 +1248,14 @@ See [inputs](#inputs) for more information.
 
 *   [aws-doc-sdk-examples: uses tj-actions/changed-files to automate testing](https://github.com/awsdocs/aws-doc-sdk-examples/blob/2393723ef6b0cad9502f4852f5c72f7be58ca89d/.github/workflows/javascript.yml#L22)
 
-*   [nhost: uses tj-actions/changed-files to automate testing based on changes detected](https://github.com/nhost/nhost/blob/main/.github/workflows/ci.yaml#L44-L48)
+*   [nhost: uses tj-actions/changed-files to automate testing based on changes detected](https://github.com/nhost/nhost/blob/71a8ce444618a8ac4d660518172fba4883c4014b/.github/workflows/ci.yaml#L44-L48)
 
 *   [qmk\_firmware uses tj-actions/changed-files to run linters](https://github.com/qmk/qmk_firmware/blob/7a737235ffd49c32d2c5561e8fe53fd96baa7f96/.github/workflows/lint.yml#L30)
 
+*   [argo-cd uses tj-actions/chnaged-files to detect changed frontend or backend files](https://github.com/argoproj/argo-cd/blob/5bc1850aa1d26301043be9f2fb825d88c80c111c/.github/workflows/ci-build.yaml#L33)
+
+*   [argo-workflows uses tj-actions/changed-files to run specific jobs based on changes detected](https://github.com/argoproj/argo-workflows/blob/baef4856ff2603c76dbe277c825eaa3f9788fc91/.github/workflows/ci-build.yaml#L34)
+
 And many more...
 
 ### Scalability Example 📈
@@ -1322,6 +1353,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     </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>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/levenleven"><img src="https://avatars.githubusercontent.com/u/6463364?v=4?s=100" width="100px;" alt="Aleksey Levenstein"/><br /><sub><b>Aleksey Levenstein</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=levenleven" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/dan-hill2802"><img src="https://avatars.githubusercontent.com/u/5046322?v=4?s=100" width="100px;" alt="Daniel Hill"/><br /><sub><b>Daniel Hill</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=dan-hill2802" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://keisukeyamashita.com"><img src="https://avatars.githubusercontent.com/u/23056537?v=4?s=100" width="100px;" alt="KeisukeYamashita"/><br /><sub><b>KeisukeYamashita</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=KeisukeYamashita" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/codesculpture"><img src="https://avatars.githubusercontent.com/u/63452117?v=4?s=100" width="100px;" alt="Aravind"/><br /><sub><b>Aravind</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=codesculpture" title="Code">💻</a> <a href="https://github.com/tj-actions/changed-files/issues?q=author%3Acodesculpture" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
 </table>

action.yml

@@ -127,7 +127,7 @@ inputs:
     required: false
     default: "false"
   json:
-    description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs. Example: https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml"
+    description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs. Example: https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml"
     required: false
     default: "false"
   escape_json:
@@ -144,8 +144,8 @@ inputs:
     default: "50"
   skip_initial_fetch:
     description: |
-      Skip the initial fetch to improve performance for shallow repositories. 
+      Skip initially fetching additional history to improve performance for shallow repositories.
-      NOTE: This could lead to errors with missing history and the intended use is limited to when you've fetched the history necessary to perform the diff.
+      NOTE: This could lead to errors with missing history. It's intended to be used when you've fetched all necessary history to perform the diff.
     required: false
     default: "false"
   fetch_additional_submodule_history:
@@ -203,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
@@ -215,6 +219,10 @@ inputs:
     description: "Apply the negation patterns first. NOTE: This affects how changed files are matched."
     required: false
     default: "false"
+  matrix:
+    description: "Output changed files in a format that can be used for matrix jobs. Alias for setting inputs `json` to `true` and `escape_json` to `false`."
+    required: false
+    default: "false"
 
 outputs:
   added_files:
@@ -262,9 +270,9 @@ outputs:
   all_changed_files_count:
     description: "Returns the number of `all_changed_files`"
   any_changed:
-    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs has changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
+    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs have changed. This defaults to `true` when no patterns are specified. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
   only_changed:
-    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
+    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs have changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
   other_changed_files:
     description: "Returns all other changed files not listed in the files input i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*."
   other_changed_files_count:
@@ -274,17 +282,17 @@ outputs:
   all_modified_files_count:
     description: "Returns the number of `all_modified_files`"
   any_modified:
-    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs has been modified. i.e. *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*."
+    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs have been modified. This defaults to `true` when no patterns are specified. i.e. *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*."
   only_modified:
-    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has been modified. (ACMRD)."
+    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs have been modified. (ACMRD)."
   other_modified_files:
     description: "Returns all other modified files not listed in the files input i.e. *a combination of all added, copied, modified, and deleted files (ACMRD)*"
   other_modified_files_count:
     description: "Returns the number of `other_modified_files`"
   any_deleted:
-    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs has been deleted. (D)"
+    description: "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs have been deleted. This defaults to `true` when no patterns are specified. (D)"
   only_deleted:
-    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has been deleted. (D)"
+    description: "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs have been deleted. (D)"
   other_deleted_files:
     description: "Returns all other deleted files not listed in the files input i.e. *a  combination of all deleted files (D)*"
   other_deleted_files_count:

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": "41.0.0",
+  "version": "42.1.0",
   "description": "Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories.",
   "main": "lib/main.js",
   "publishConfig": {
@@ -46,8 +46,8 @@
     "@types/micromatch": "^4.0.2",
     "@types/node": "^20.3.2",
     "@types/uuid": "^9.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
     "@vercel/ncc": "^0.38.0",
     "eslint": "^8.43.0",
     "eslint-plugin-github": "^4.8.0",

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

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

src/__tests__/inputs.test.ts

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

src/__tests__/utils.test.ts

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

src/changedFiles.ts

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

src/changedFilesOutput.ts

@@ -247,7 +247,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
 
   await setOutput({
     key: getOutputKey('any_changed', outputPrefix),
-    value: allChangedFiles.paths.length > 0 && filePatterns.length > 0,
+    value: allChangedFiles.paths.length > 0,
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json
@@ -336,7 +336,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
 
   await setOutput({
     key: getOutputKey('any_modified', outputPrefix),
-    value: allModifiedFiles.paths.length > 0 && filePatterns.length > 0,
+    value: allModifiedFiles.paths.length > 0,
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json
@@ -442,7 +442,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
 
   await setOutput({
     key: getOutputKey('any_deleted', outputPrefix),
-    value: deletedFiles.paths.length > 0 && filePatterns.length > 0,
+    value: deletedFiles.paths.length > 0,
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json
@@ -496,7 +496,7 @@ export const setOutputsAndGetModifiedAndChangedFilesStatus = async ({
   })
 
   return {
-    anyModified: allModifiedFiles.paths.length > 0 && filePatterns.length > 0,
+    anyModified: allModifiedFiles.paths.length > 0,
-    anyChanged: allChangedFiles.paths.length > 0 && filePatterns.length > 0
+    anyChanged: allChangedFiles.paths.length > 0
   }
 }

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: [
@@ -429,7 +429,7 @@ export const getSHAForPullRequestEvent = async (
 
   if (
     !github.context.payload.pull_request?.base?.ref ||
-    github.context.payload.head?.repo?.fork === 'true'
+    github.context.payload.pull_request?.head?.repo?.fork === true
   ) {
     diff = '..'
   }

src/constant.ts

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

src/env.ts

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

src/inputs.ts

@@ -24,7 +24,7 @@ export type Inputs = {
   since: string
   until: string
   path: string
-  quotePath: boolean
+  quotepath: boolean
   diffRelative: boolean
   dirNames: boolean
   dirNamesMaxDepth?: number
@@ -36,7 +36,7 @@ export type Inputs = {
   escapeJson: boolean
   safeOutput: boolean
   fetchDepth?: number
-  fetchSubmoduleHistory: boolean
+  fetchAdditionalSubmoduleHistory: boolean
   sinceLastRemoteCommit: boolean
   writeOutputFiles: boolean
   outputDir: string
@@ -53,6 +53,7 @@ export type Inputs = {
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
   negationPatternsFirst: boolean
+  useRestApi: boolean
 }
 
 export const getInputs = (): Inputs => {
@@ -131,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', {
@@ -153,8 +154,15 @@ export const getInputs = (): Inputs => {
       trimWhitespace: false
     }
   )
-  const json = core.getBooleanInput('json', {required: false})
+  let json = core.getBooleanInput('json', {required: false})
-  const escapeJson = core.getBooleanInput('escape_json', {required: false})
+  let escapeJson = core.getBooleanInput('escape_json', {required: false})
+  const matrix = core.getBooleanInput('matrix', {required: false})
+
+  if (matrix) {
+    json = true
+    escapeJson = false
+  }
+
   const safeOutput = core.getBooleanInput('safe_output', {required: false})
   const fetchDepth = core.getInput('fetch_depth', {required: false})
   const sinceLastRemoteCommit = core.getBooleanInput(
@@ -196,7 +204,7 @@ export const getInputs = (): Inputs => {
   const skipInitialFetch = core.getBooleanInput('skip_initial_fetch', {
     required: false
   })
-  const fetchSubmoduleHistory = core.getBooleanInput(
+  const fetchAdditionalSubmoduleHistory = core.getBooleanInput(
     'fetch_additional_submodule_history',
     {
       required: false
@@ -228,6 +236,10 @@ export const getInputs = (): Inputs => {
     }
   )
 
+  const useRestApi = core.getBooleanInput('use_rest_api', {
+    required: false
+  })
+
   const inputs: Inputs = {
     files,
     filesSeparator,
@@ -252,7 +264,7 @@ export const getInputs = (): Inputs => {
     since,
     until,
     path,
-    quotePath,
+    quotepath,
     diffRelative,
     sinceLastRemoteCommit,
     recoverDeletedFiles,
@@ -265,7 +277,7 @@ export const getInputs = (): Inputs => {
     oldNewSeparator,
     oldNewFilesSeparator,
     skipInitialFetch,
-    fetchSubmoduleHistory,
+    fetchAdditionalSubmoduleHistory,
     dirNamesDeletedFilesIncludeOnlyDeletedDirs,
     // End Not Supported via REST API
     dirNames,
@@ -280,7 +292,8 @@ export const getInputs = (): Inputs => {
     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
   })
@@ -224,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}`)
 
@@ -243,35 +244,19 @@ export async function run(): Promise<void> {
   })
   core.debug(`Yaml file patterns: ${JSON.stringify(yamlFilePatterns)}`)
 
+  if (inputs.useRestApi && !github.context.payload.pull_request?.number) {
+    throw new Error(
+      "Only pull_request* events are supported when using GitHub's REST API."
+    )
+  }
+
   if (
     inputs.token &&
     github.context.payload.pull_request?.number &&
-    !hasGitDirectory
+    (!hasGitDirectory || inputs.useRestApi)
   ) {
     core.info("Using GitHub's REST API to get changed files")
-    const unsupportedInputs: (keyof Inputs)[] = [
+    await warnUnsupportedRESTAPIInputs({inputs})
-      'sha',
-      'baseSha',
-      'since',
-      'until',
-      'sinceLastRemoteCommit',
-      'recoverDeletedFiles',
-      'recoverDeletedFilesToDestination',
-      'recoverFiles',
-      'recoverFilesIgnore',
-      'includeAllOldNewRenamedFiles',
-      'skipInitialFetch',
-      'fetchSubmoduleHistory',
-      'dirNamesDeletedFilesIncludeOnlyDeletedDirs'
-    ]
-
-    for (const input of unsupportedInputs) {
-      if (inputs[input]) {
-        core.warning(
-          `Input "${input}" is not supported when using GitHub's REST API to get changed files`
-        )
-      }
-    }
     await getChangedFilesFromRESTAPI({
       inputs,
       filePatterns,
@@ -279,10 +264,9 @@ export async function run(): Promise<void> {
     })
   } else {
     if (!hasGitDirectory) {
-      core.setFailed(
+      throw new Error(
-        "Can't find local .git directory. Please run actions/checkout before this action"
+        `Unable to locate the git repository in the given path: ${workingDirectory}.\n Please run actions/checkout before this action (Make sure the 'path' input is correct).\n If you intend to use Github's REST API note that only pull_request* events are supported. Current event is "${github.context.eventName}".`
       )
-      return
     }
 
     core.info('Using local .git directory')
@@ -301,5 +285,6 @@ if (!process.env.TESTING) {
   // eslint-disable-next-line github/no-then
   run().catch(e => {
     core.setFailed(e.message || e)
+    process.exit(1)
   })
 }

src/utils.ts

@@ -3,14 +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 {DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS} from './constant'
 import {Inputs} from './inputs'
 
 const MINIMUM_GIT_VERSION = '2.18.0'
@@ -171,15 +171,16 @@ async function* lineOfFileGenerator({
     input: fileStream,
     crlfDelay: Infinity
   })
-  for await (const line of rl) {
+  for await (let line of rl) {
     if (!line.startsWith('#') && line !== '') {
       if (excludedFiles) {
-        if (line.startsWith('!')) {
+        line = line.startsWith('!') ? line : `!${line}`
-          yield line
+        if (line.endsWith(path.sep)) {
-        } else {
+          line = `${line}**`
-          yield `!${line}`
         }
+        yield line
       } else {
+        line = line.endsWith(path.sep) ? `${line}**` : line
         yield line
       }
     }
@@ -285,6 +286,7 @@ export const submoduleExists = async ({
  * Fetches the git repository
  * @param args - arguments for fetch command
  * @param cwd - working directory
+ * @returns exit code
  */
 export const gitFetch = async ({
   args,
@@ -333,6 +335,7 @@ export const gitFetchSubmodules = async ({
 /**
  * Retrieves all the submodule paths
  * @param cwd - working directory
+ * @returns submodule paths
  */
 export const getSubmodulePath = async ({
   cwd
@@ -367,6 +370,7 @@ export const getSubmodulePath = async ({
  * @param parentSha2 - parent commit sha
  * @param submodulePath - path of submodule
  * @param diff - diff type between parent commits (`..` or `...`)
+ * @returns commit sha of submodule
  */
 export const gitSubmoduleDiffSHA = async ({
   cwd,
@@ -676,6 +680,12 @@ export const isInsideWorkTree = async ({
     }
   )
 
+  if (stdout.trim() !== 'true') {
+    core.warning(
+      `The current working directory is not inside a git repository: ${cwd}`
+    )
+  }
+
   return stdout.trim() === 'true'
 }
 
@@ -898,7 +908,7 @@ export const canDiffCommits = async ({
   } else {
     const {exitCode, stderr} = await exec.getExecOutput(
       'git',
-      ['diff', '--quiet', sha1, sha2],
+      ['diff', '--no-patch', sha1, sha2],
       {
         cwd,
         ignoreReturnCode: true,
@@ -995,6 +1005,7 @@ export const getFilePatterns = async ({
   if (inputs.files) {
     const filesPatterns = inputs.files
       .split(inputs.filesSeparator)
+      .map(p => (p.endsWith(path.sep) ? `${p}**` : p))
       .filter(Boolean)
 
     cleanedFilePatterns.push(...filesPatterns)
@@ -1026,8 +1037,9 @@ export const getFilePatterns = async ({
       .split(inputs.filesIgnoreSeparator)
       .filter(Boolean)
       .map(p => {
-        if (!p.startsWith('!')) {
+        p = p.startsWith('!') ? p : `!${p}`
-          p = `!${p}`
+        if (p.endsWith(path.sep)) {
+          p = `${p}**`
         }
         return p
       })
@@ -1128,7 +1140,7 @@ const getYamlFilePatternsFromContents = async ({
       throw new Error(`File does not exist: ${filePath}`)
     }
 
-    source = await readFile(filePath, 'utf8')
+    source = await fs.readFile(filePath, 'utf8')
   } else {
     source = content
   }
@@ -1491,6 +1503,12 @@ export const recoverDeletedFiles = async ({
   }
 }
 
+/**
+ * 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
 }: {
@@ -1500,3 +1518,33 @@ export const hasLocalGitDirectory = async ({
     cwd: workingDirectory
   })
 }
+
+/**
+ * Warns about unsupported inputs when using the REST API.
+ *
+ * @param inputs - The inputs object.
+ */
+export const warnUnsupportedRESTAPIInputs = async ({
+  inputs
+}: {
+  inputs: Inputs
+}): Promise<void> => {
+  for (const key of Object.keys(DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS)) {
+    const defaultValue = Object.hasOwnProperty.call(
+      DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS,
+      key
+    )
+      ? DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS[
+          key as keyof Inputs
+        ]?.toString()
+      : ''
+
+    if (defaultValue !== inputs[key as keyof Inputs]?.toString()) {
+      core.warning(
+        `Input "${snakeCase(
+          key
+        )}" is not supported when using GitHub's REST API to get changed files`
+      )
+    }
+  }
+}