chore(deps-dev): bump @types/node from 20.14.13 to 22.0.0 (#2215)

Co-authored-by: dependabot[bot] <49699333+dependabot[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.5
         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
-          quotepath: false
-          escape_json: false
+          matrix: true
       - 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.1.0
         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.3
         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@v25
         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@v20
         id: changed_files
         with:
           files: |
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -411,7 +430,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
@@ -465,7 +485,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
@@ -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
@@ -589,11 +682,34 @@ jobs:
           echo "${{ toJSON(steps.changed-files.outputs) }}"
         shell:
           bash
+
+      - name: Run changed-files excluding submodule
+        id: changed-files-exclude-submodule
+        uses: ./
+        with:
+          base_sha: "85bd869"
+          sha: "adde7bb"
+          fetch_depth: 60000
+          exclude_submodules: true
+
+      - name: Verify no added files
+        if: steps.changed-files-exclude-submodule.outputs.added_files != ''
+        run: |
+          echo "Expected: ('') got ${{ steps.changed-files-exclude-submodule.outputs.added_files }}"
+          exit 1
+
+      - name: Show output
+        run: |
+          echo "${{ toJSON(steps.changed-files-exclude-submodule.outputs) }}"
+        shell:
+          bash
   test-yaml:
     name: Test changed-files with yaml
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -669,6 +785,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
@@ -859,6 +977,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
@@ -889,14 +1009,19 @@ jobs:
           bash
   test-dir-names-deleted-files-include-only-deleted-dirs-directory:
     name: Test dir names deleted files include only deleted dirs
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.platform }}
     needs: build
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     steps:
       - name: Checkout branch
         uses: actions/checkout@v4
         with:
-          ref: cd1e384723e4d1a184568182ac2b27c53ebf017f
+          ref: ${{ github.event.pull_request.head.sha }}
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           submodules: true
           fetch-depth: 2
@@ -908,6 +1033,7 @@ jobs:
           sha: cd1e384723e4d1a184568182ac2b27c53ebf017f
           dir_names: true
           dir_names_deleted_files_include_only_deleted_dirs: true
+          fetch_depth: 60000
       - name: Show output
         run: |
           echo '${{ toJSON(steps.changed-files-dir-names-deleted-files-include-only-deleted-dirs-directory.outputs) }}'
@@ -927,12 +1053,43 @@ jobs:
           exit 1
         shell:
           bash
+      - name: Run changed-files with dir_names and dir_names_deleted_files_include_only_deleted_dirs with the test directory deleted returns posix path separator
+        id: changed-files-dir-names-deleted-files-include-only-deleted-dirs-directory-posix-path-separator
+        uses: ./
+        with:
+          base_sha: a52f8621d26d5d9f54b80f74bda2d9eedff94693
+          sha: cd1e384723e4d1a184568182ac2b27c53ebf017f
+          dir_names: true
+          dir_names_deleted_files_include_only_deleted_dirs: true
+          use_posix_path_separator: true
+          fetch_depth: 60000
+      - name: Show output
+        run: |
+          echo '${{ toJSON(steps.changed-files-dir-names-deleted-files-include-only-deleted-dirs-directory-posix-path-separator.outputs) }}'
+        shell:
+          bash
+      - name: Check deleted_files output on non windows platform
+        if: steps.changed-files-dir-names-deleted-files-include-only-deleted-dirs-directory-posix-path-separator.outputs.deleted_files != 'test/test3' && runner.os != 'Windows'
+        run: |
+          echo "Invalid output: Expected (test/test3) got (${{ steps.changed-files-dir-names-deleted-files-include-only-deleted-dirs-directory-posix-path-separator.outputs.deleted_files }})"
+          exit 1
+        shell:
+          bash
+      - name: Check deleted_files output on windows platform
+        if: "!contains(steps.changed-files-dir-names-deleted-files-include-only-deleted-dirs-directory-posix-path-separator.outputs.deleted_files, 'test/test3') && runner.os == 'Windows'"
+        run: |
+          echo "Invalid output: Expected (test/test3) got (${{ steps.changed-files-dir-names-deleted-files-include-only-deleted-dirs-directory-posix-path-separator.outputs.deleted_files }})"
+          exit 1
+        shell:
+          bash
 
   test-since-last-remote-commit:
     name: Test changed-files since last remote commit
     runs-on: ubuntu-latest
     needs: build
     if: needs.build.outputs.files_changed != 'true'
+    permissions:
+      contents: read
     strategy:
       fail-fast: false
       max-parallel: 4
@@ -960,7 +1117,7 @@ jobs:
         with:
           since_last_remote_commit: true
 
-      - name: Verify failed
+      - name: Verify succeeded pull_request(closed)
         if: steps.changed-files-since-last-remote-commit.outcome != 'failure' && matrix.fetch-depth == 1 && github.event.action == 'closed' && github.event_name == 'pull_request'
         run: |
           echo "Expected: (failure) got ${{ steps.changed-files-since-last-remote-commit.outcome }}"
@@ -983,6 +1140,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
@@ -1013,7 +1172,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@v20
         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 }}"

action.yml

@@ -127,21 +127,25 @@ inputs:
     required: false
     default: "false"
   json:
-    description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs. Example: https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml"
+    description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs. Example: https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml"
     required: false
     default: "false"
   escape_json:
     description: "Escape JSON output."
     required: false
     default: "true"
+  safe_output:
+    description: "Apply sanitization to output filenames before being set as output."
+    required: false
+    default: "true"
   fetch_depth:
     description: "Depth of additional branch history fetched. NOTE: This can be adjusted to resolve errors with insufficient history."
     required: false
-    default: "50"
+    default: "25"
   skip_initial_fetch:
     description: |
-      Skip the initial fetch to improve performance for shallow repositories. 
-      NOTE: This could lead to errors with missing history and the intended use is limited to when you've fetched the history necessary to perform the diff.
+      Skip initially fetching additional history to improve performance for shallow repositories.
+      NOTE: This could lead to errors with missing history. It's intended to be used when you've fetched all necessary history to perform the diff.
     required: false
     default: "false"
   fetch_additional_submodule_history:
@@ -199,6 +203,10 @@ inputs:
     description: "Github API URL."
     required: false
     default: ${{ github.api_url }}
+  use_rest_api:
+    description: "Force the use of Github's REST API even when a local copy of the repository exists"
+    required: false
+    default: "false"
   fail_on_initial_diff_error:
     description: "Fail when the initial diff fails."
     required: false
@@ -211,6 +219,31 @@ 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"
+  exclude_submodules:
+    description: "Exclude changes to submodules."
+    required: false
+    default: "false"
+  fetch_missing_history_max_retries:
+    description: "Maximum number of retries to fetch missing history."
+    required: false
+    default: "20"
+  use_posix_path_separator:
+    description: "Use POSIX path separator `/` for output file paths on Windows."
+    required: false
+    default: "false"
+  tags_pattern:
+    description: "Tags pattern to include."
+    required: false
+    default: "*"
+  tags_ignore_pattern:
+    description: "Tags pattern to ignore."
+    required: false
+    default: ""
+
 
 outputs:
   added_files:
@@ -250,45 +283,45 @@ outputs:
   unknown_files_count:
     description: "Returns the number of `unknown_files`"
   all_changed_and_modified_files:
-    description: "Returns all changed and modified files i.e. *a combination of (ACMRDTUX)*"
+    description: "Returns all changed and modified files i.e. a combination of (ACMRDTUX)"
   all_changed_and_modified_files_count:
     description: "Returns the number of `all_changed_and_modified_files`"
   all_changed_files:
-    description: "Returns all changed files i.e. *a combination of all added, copied, modified and renamed files (ACMR)*"
+    description: "Returns all changed files i.e. a combination of all added, copied, modified and renamed files (ACMR)"
   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)*."
+    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:
     description: "Returns the number of `other_changed_files`"
   all_modified_files:
-    description: "Returns all changed files i.e. *a combination of all added, copied, modified, renamed and deleted files (ACMRD)*."
+    description: "Returns all changed files i.e. a combination of all added, copied, modified, renamed and deleted files (ACMRD)."
   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)*"
+    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)*"
+    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:
     description: "Returns the number of `other_deleted_files`"
   modified_keys:
-    description: "Returns all modified YAML keys when the `files_yaml` input is used. i.e. *key that contains any path that has either been added, copied, modified, and deleted (ACMRD)*"
+    description: "Returns all modified YAML keys when the `files_yaml` input is used. i.e. key that contains any path that has either been added, copied, modified, and deleted (ACMRD)"
   changed_keys:
-    description: "Returns all changed YAML keys when the `files_yaml` input is used. i.e. *key that contains any path that has either been added, copied, modified, and renamed (ACMR)*"
+    description: "Returns all changed YAML keys when the `files_yaml` input is used. i.e. key that contains any path that has either been added, copied, modified, and renamed (ACMR)"
 
 runs:
   using: 'node20'

jest.config.js

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

jest/setupEnv.cjs

@@ -1,6 +1,5 @@
 const path = require('path')
 
-process.env.TESTING = "1"
 process.env.GITHUB_WORKSPACE = path.join(
   path.resolve(__dirname, '..'), '.'
 )

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tj-actions/changed-files",
-  "version": "40.2.2",
+  "version": "44.5.6",
   "description": "Github action to retrieve all (added, copied, modified, deleted, renamed, type changed, unmerged, unknown) files and directories.",
   "main": "lib/main.js",
   "publishConfig": {
@@ -14,6 +14,7 @@
     "lint:fix": "eslint --fix src/*.ts src/**/*.ts",
     "package": "ncc build lib/main.js --source-map --license licenses.txt",
     "test": "jest --coverage",
+    "update-snapshot": "jest -u",
     "all": "yarn build && yarn format && yarn lint && yarn package && yarn test"
   },
   "repository": {
@@ -35,7 +36,8 @@
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1",
     "@actions/github": "^6.0.0",
-    "@octokit/rest": "^20.0.1",
+    "@octokit/rest": "^21.0.0",
+    "@stdlib/utils-convert-path": "^0.2.1",
     "lodash": "^4.17.21",
     "micromatch": "^4.0.5",
     "yaml": "^2.3.1"
@@ -44,16 +46,16 @@
     "@types/jest": "^29.5.2",
     "@types/lodash": "^4.14.195",
     "@types/micromatch": "^4.0.2",
-    "@types/node": "^20.3.2",
-    "@types/uuid": "^9.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
+    "@types/node": "^22.0.0",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
     "@vercel/ncc": "^0.38.0",
     "eslint": "^8.43.0",
-    "eslint-plugin-github": "^4.8.0",
-    "eslint-plugin-jest": "^27.2.2",
-    "eslint-plugin-prettier": "^5.0.0-alpha.2",
     "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-github": "^5.0.0",
+    "eslint-plugin-jest": "^28.0.0",
+    "eslint-plugin-prettier": "^5.0.0-alpha.2",
     "jest": "^29.5.0",
     "prettier": "^3.0.0",
     "ts-jest": "^29.1.0",

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

@@ -0,0 +1,373 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getInputs should correctly parse boolean inputs 1`] = `
+{
+  "apiUrl": "",
+  "baseSha": "",
+  "diffRelative": "false",
+  "dirNames": "false",
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": "false",
+  "dirNamesExcludeCurrentDir": "false",
+  "dirNamesIncludeFiles": "",
+  "dirNamesIncludeFilesSeparator": "",
+  "escapeJson": false,
+  "excludeSubmodules": "false",
+  "failOnInitialDiffError": "false",
+  "failOnSubmoduleDiffError": "false",
+  "fetchAdditionalSubmoduleHistory": "false",
+  "fetchMissingHistoryMaxRetries": 20,
+  "files": "",
+  "filesFromSourceFile": "",
+  "filesFromSourceFileSeparator": "",
+  "filesIgnore": "",
+  "filesIgnoreFromSourceFile": "",
+  "filesIgnoreFromSourceFileSeparator": "",
+  "filesIgnoreSeparator": "",
+  "filesIgnoreYaml": "",
+  "filesIgnoreYamlFromSourceFile": "",
+  "filesIgnoreYamlFromSourceFileSeparator": "",
+  "filesSeparator": "",
+  "filesYaml": "",
+  "filesYamlFromSourceFile": "",
+  "filesYamlFromSourceFileSeparator": "",
+  "includeAllOldNewRenamedFiles": "false",
+  "json": true,
+  "negationPatternsFirst": "false",
+  "oldNewFilesSeparator": " ",
+  "oldNewSeparator": ",",
+  "outputDir": "",
+  "outputRenamedFilesAsDeletedAndAdded": "false",
+  "path": ".",
+  "quotepath": "false",
+  "recoverDeletedFiles": "false",
+  "recoverDeletedFilesToDestination": "",
+  "recoverFiles": "",
+  "recoverFilesIgnore": "",
+  "recoverFilesIgnoreSeparator": "
+",
+  "recoverFilesSeparator": "
+",
+  "safeOutput": "false",
+  "separator": "",
+  "sha": "",
+  "since": "",
+  "sinceLastRemoteCommit": "false",
+  "skipInitialFetch": "true",
+  "tagsIgnorePattern": "",
+  "tagsPattern": "*",
+  "token": "",
+  "until": "",
+  "usePosixPathSeparator": "false",
+  "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,
+  "excludeSubmodules": 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,
+  "tagsIgnorePattern": "",
+  "tagsPattern": "",
+  "token": "",
+  "until": "",
+  "usePosixPathSeparator": false,
+  "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,
+  "excludeSubmodules": 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,
+  "tagsIgnorePattern": "",
+  "tagsPattern": "",
+  "token": "token",
+  "until": "",
+  "usePosixPathSeparator": false,
+  "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,
+  "excludeSubmodules": 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,
+  "tagsIgnorePattern": "",
+  "tagsPattern": "",
+  "token": "",
+  "until": "",
+  "usePosixPathSeparator": false,
+  "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,
+  "excludeSubmodules": 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,
+  "tagsIgnorePattern": "",
+  "tagsPattern": "",
+  "token": "",
+  "until": "",
+  "usePosixPathSeparator": false,
+  "useRestApi": false,
+  "writeOutputFiles": false,
+}
+`;
+
+exports[`getInputs should return default values when no inputs are provided 1`] = `
+{
+  "apiUrl": "",
+  "baseSha": "",
+  "diffRelative": true,
+  "dirNames": false,
+  "dirNamesDeletedFilesIncludeOnlyDeletedDirs": false,
+  "dirNamesExcludeCurrentDir": false,
+  "dirNamesIncludeFiles": "",
+  "dirNamesIncludeFilesSeparator": "",
+  "escapeJson": false,
+  "excludeSubmodules": false,
+  "failOnInitialDiffError": false,
+  "failOnSubmoduleDiffError": false,
+  "fetchAdditionalSubmoduleHistory": false,
+  "fetchMissingHistoryMaxRetries": 20,
+  "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,
+  "tagsIgnorePattern": "",
+  "tagsPattern": "*",
+  "token": "",
+  "until": "",
+  "usePosixPathSeparator": false,
+  "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.getInput 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.getInput 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,14 @@
+import * as core from '@actions/core'
+import * as exec from '@actions/exec'
 import {ChangeTypeEnum} from '../changedFiles'
+import {Inputs} from '../inputs'
 import {
   getDirname,
   getDirnameMaxDepth,
   getFilteredChangedFiles,
-  normalizeSeparators
+  getPreviousGitTag,
+  normalizeSeparators,
+  warnUnsupportedRESTAPIInputs
 } from '../utils'
 
 const originalPlatform = process.platform
@@ -575,4 +580,173 @@ 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,
+        excludeSubmodules: false,
+        fetchMissingHistoryMaxRetries: 20,
+        usePosixPathSeparator: false,
+        tagsPattern: '*',
+        tagsIgnorePattern: ''
+      }
+
+      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)
+    })
+  })
+  describe('getPreviousGitTag', () => {
+    // Function returns the second-latest tag and its SHA
+    it('should return the second latest tag and its SHA when multiple tags are present', async () => {
+      const result = await getPreviousGitTag({
+        cwd: '.',
+        tagsPattern: '*',
+        tagsIgnorePattern: '',
+        currentBranch: 'v1.0.1'
+      })
+      expect(result).toEqual({
+        tag: 'v1.0.0',
+        sha: 'f0751de6af436d4e79016e2041cf6400e0833653'
+      })
+    })
+
+    // Tags are filtered by a specified pattern when 'tagsPattern' is provided
+    it('should filter tags by the specified pattern', async () => {
+      const result = await getPreviousGitTag({
+        cwd: '.',
+        tagsPattern: 'v1.*',
+        tagsIgnorePattern: '',
+        currentBranch: 'v1.0.1'
+      })
+      expect(result).toEqual({
+        tag: 'v1.0.0',
+        sha: 'f0751de6af436d4e79016e2041cf6400e0833653'
+      })
+    })
+
+    // Tags are excluded by a specified ignore pattern when 'tagsIgnorePattern' is provided
+    it('should exclude tags by the specified ignore pattern', async () => {
+      const result = await getPreviousGitTag({
+        cwd: '.',
+        tagsPattern: '*',
+        tagsIgnorePattern: 'v0.*.*',
+        currentBranch: 'v1.0.1'
+      })
+      expect(result).toEqual({
+        tag: 'v1.0.0',
+        sha: 'f0751de6af436d4e79016e2041cf6400e0833653'
+      })
+    })
+
+    // No tags are available in the repository
+    it('should return empty values when no tags are available in the repository', async () => {
+      jest.spyOn(exec, 'getExecOutput').mockResolvedValueOnce({
+        stdout: '',
+        stderr: '',
+        exitCode: 0
+      })
+      const result = await getPreviousGitTag({
+        cwd: '.',
+        tagsPattern: '*',
+        tagsIgnorePattern: '',
+        currentBranch: ''
+      })
+      expect(result).toEqual({tag: '', sha: ''})
+    })
+
+    // Only one tag is available, making it impossible to find a previous tag
+    it('should return empty values when only one tag is available', async () => {
+      jest.spyOn(exec, 'getExecOutput').mockResolvedValueOnce({
+        stdout:
+          'v1.0.1|f0751de6af436d4e79016e2041cf6400e0833653|2021-01-01T00:00:00Z',
+        stderr: '',
+        exitCode: 0
+      })
+      const result = await getPreviousGitTag({
+        cwd: '.',
+        tagsPattern: '*',
+        tagsIgnorePattern: '',
+        currentBranch: 'v1.0.1'
+      })
+      expect(result).toEqual({tag: '', sha: ''})
+    })
+
+    // Git commands fail and throw errors
+    it('should throw an error when git commands fail', async () => {
+      jest
+        .spyOn(exec, 'getExecOutput')
+        .mockRejectedValue(new Error('git command failed'))
+      await expect(
+        getPreviousGitTag({
+          cwd: '.',
+          tagsPattern: '*',
+          tagsIgnorePattern: '',
+          currentBranch: 'v1.0.1'
+        })
+      ).rejects.toThrow('git command failed')
+    })
+  })
 })

src/changedFiles.ts

@@ -2,6 +2,7 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import type {RestEndpointMethodTypes} from '@octokit/rest'
 import flatten from 'lodash/flatten'
+import convertPath from '@stdlib/utils-convert-path'
 import mm from 'micromatch'
 import * as path from 'path'
 import {setOutputsAndGetModifiedAndChangedFilesStatus} from './changedFilesOutput'
@@ -121,13 +122,13 @@ export const processChangedFiles = async ({
 export const getRenamedFiles = async ({
   inputs,
   workingDirectory,
-  hasSubmodule,
+  diffSubmodule,
   diffResult,
   submodulePaths
 }: {
   inputs: Inputs
   workingDirectory: string
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   diffResult: DiffResult
   submodulePaths: string[]
 }): Promise<{paths: string; count: string}> => {
@@ -139,7 +140,7 @@ export const getRenamedFiles = async ({
     oldNewSeparator: inputs.oldNewSeparator
   })
 
-  if (hasSubmodule) {
+  if (diffSubmodule) {
     for (const submodulePath of submodulePaths) {
       const submoduleShaResult = await gitSubmoduleDiffSHA({
         cwd: workingDirectory,
@@ -166,7 +167,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)
@@ -217,20 +218,20 @@ export type ChangedFiles = {
 
 export const getAllDiffFiles = async ({
   workingDirectory,
-  hasSubmodule,
+  diffSubmodule,
   diffResult,
   submodulePaths,
   outputRenamedFilesAsDeletedAndAdded,
-  fetchSubmoduleHistory,
+  fetchAdditionalSubmoduleHistory,
   failOnInitialDiffError,
   failOnSubmoduleDiffError
 }: {
   workingDirectory: string
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   diffResult: DiffResult
   submodulePaths: string[]
   outputRenamedFilesAsDeletedAndAdded: boolean
-  fetchSubmoduleHistory: boolean
+  fetchAdditionalSubmoduleHistory: boolean
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
 }): Promise<ChangedFiles> => {
@@ -243,7 +244,7 @@ export const getAllDiffFiles = async ({
     failOnInitialDiffError
   })
 
-  if (hasSubmodule) {
+  if (diffSubmodule) {
     for (const submodulePath of submodulePaths) {
       const submoduleShaResult = await gitSubmoduleDiffSHA({
         cwd: workingDirectory,
@@ -270,7 +271,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)
@@ -355,7 +356,11 @@ function* getChangeTypeFilesGenerator({
       filePaths,
       dirNamesIncludeFilePatterns
     })) {
-      yield filePath
+      if (isWindows() && inputs.usePosixPathSeparator) {
+        yield convertPath(filePath, 'mixed')
+      } else {
+        yield filePath
+      }
     }
   }
 }
@@ -402,7 +407,11 @@ function* getAllChangeTypeFilesGenerator({
     filePaths,
     dirNamesIncludeFilePatterns
   })) {
-    yield filePath
+    if (isWindows() && inputs.usePosixPathSeparator) {
+      yield convertPath(filePath, 'mixed')
+    } else {
+      yield filePath
+    }
   }
 }
 

src/changedFilesOutput.ts

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

src/commitSha.ts

@@ -86,15 +86,27 @@ export interface DiffResult {
   initialCommit?: boolean
 }
 
-export const getSHAForNonPullRequestEvent = async (
-  inputs: Inputs,
-  env: Env,
-  workingDirectory: string,
-  isShallow: boolean,
-  hasSubmodule: boolean,
-  gitFetchExtraArgs: string[],
+interface SHAForNonPullRequestEvent {
+  inputs: Inputs
+  env: Env
+  workingDirectory: string
+  isShallow: boolean
+  diffSubmodule: boolean
+  gitFetchExtraArgs: string[]
   isTag: boolean
-): Promise<DiffResult> => {
+  remoteName: string
+}
+
+export const getSHAForNonPullRequestEvent = async ({
+  inputs,
+  env,
+  workingDirectory,
+  isShallow,
+  diffSubmodule,
+  gitFetchExtraArgs,
+  isTag,
+  remoteName
+}: SHAForNonPullRequestEvent): Promise<DiffResult> => {
   let targetBranch = env.GITHUB_REF_NAME
   let currentBranch = targetBranch
   let initialCommit = false
@@ -122,8 +134,8 @@ export const getSHAForNonPullRequestEvent = async (
             '-u',
             '--progress',
             `--deepen=${inputs.fetchDepth}`,
-            'origin',
-            `+refs/heads/${sourceBranch}:refs/remotes/origin/${sourceBranch}`
+            remoteName,
+            `+refs/heads/${sourceBranch}:refs/remotes/${remoteName}/${sourceBranch}`
           ]
         })
       } else {
@@ -134,13 +146,13 @@ export const getSHAForNonPullRequestEvent = async (
             '-u',
             '--progress',
             `--deepen=${inputs.fetchDepth}`,
-            'origin',
-            `+refs/heads/${targetBranch}:refs/remotes/origin/${targetBranch}`
+            remoteName,
+            `+refs/heads/${targetBranch}:refs/remotes/${remoteName}/${targetBranch}`
           ]
         })
       }
 
-      if (hasSubmodule) {
+      if (diffSubmodule) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -152,7 +164,7 @@ export const getSHAForNonPullRequestEvent = async (
         })
       }
     } else {
-      if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+      if (diffSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -228,7 +240,12 @@ export const getSHAForNonPullRequestEvent = async (
       }
     } else if (isTag) {
       core.debug('Getting previous SHA for tag...')
-      const {sha, tag} = await getPreviousGitTag({cwd: workingDirectory})
+      const {sha, tag} = await getPreviousGitTag({
+        cwd: workingDirectory,
+        tagsPattern: inputs.tagsPattern,
+        tagsIgnorePattern: inputs.tagsIgnorePattern,
+        currentBranch
+      })
       previousSha = sha
       targetBranch = tag
     } else {
@@ -307,14 +324,23 @@ export const getSHAForNonPullRequestEvent = async (
   }
 }
 
-export const getSHAForPullRequestEvent = async (
-  inputs: Inputs,
-  env: Env,
-  workingDirectory: string,
-  isShallow: boolean,
-  hasSubmodule: boolean,
+interface SHAForPullRequestEvent {
+  inputs: Inputs
+  workingDirectory: string
+  isShallow: boolean
+  diffSubmodule: boolean
   gitFetchExtraArgs: string[]
-): Promise<DiffResult> => {
+  remoteName: string
+}
+
+export const getSHAForPullRequestEvent = async ({
+  inputs,
+  workingDirectory,
+  isShallow,
+  diffSubmodule,
+  gitFetchExtraArgs,
+  remoteName
+}: SHAForPullRequestEvent): Promise<DiffResult> => {
   let targetBranch = github.context.payload.pull_request?.base?.ref
   const currentBranch = github.context.payload.pull_request?.head?.ref
   if (inputs.sinceLastRemoteCommit) {
@@ -330,7 +356,7 @@ export const getSHAForPullRequestEvent = async (
           ...gitFetchExtraArgs,
           '-u',
           '--progress',
-          'origin',
+          remoteName,
           `pull/${github.context.payload.pull_request?.number}/head:${currentBranch}`
         ]
       })
@@ -343,8 +369,8 @@ export const getSHAForPullRequestEvent = async (
             '-u',
             '--progress',
             `--deepen=${inputs.fetchDepth}`,
-            'origin',
-            `+refs/heads/${currentBranch}*:refs/remotes/origin/${currentBranch}*`
+            remoteName,
+            `+refs/heads/${currentBranch}*:refs/remotes/${remoteName}/${currentBranch}*`
           ]
         })
       }
@@ -354,35 +380,32 @@ export const getSHAForPullRequestEvent = async (
           'Failed to fetch pull request branch. Please ensure "persist-credentials" is set to "true" when checking out the repository. See: https://github.com/actions/checkout#usage'
         )
       }
+      core.debug('Fetching target branch...')
+      await gitFetch({
+        cwd: workingDirectory,
+        args: [
+          ...gitFetchExtraArgs,
+          '-u',
+          '--progress',
+          `--deepen=${inputs.fetchDepth}`,
+          remoteName,
+          `+refs/heads/${github.context.payload.pull_request?.base?.ref}:refs/remotes/${remoteName}/${github.context.payload.pull_request?.base?.ref}`
+        ]
+      })
 
-      if (!inputs.sinceLastRemoteCommit) {
-        core.debug('Fetching target branch...')
-        await gitFetch({
+      if (diffSubmodule) {
+        await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
             ...gitFetchExtraArgs,
             '-u',
             '--progress',
-            `--deepen=${inputs.fetchDepth}`,
-            'origin',
-            `+refs/heads/${targetBranch}:refs/remotes/origin/${targetBranch}`
+            `--deepen=${inputs.fetchDepth}`
           ]
         })
-
-        if (hasSubmodule) {
-          await gitFetchSubmodules({
-            cwd: workingDirectory,
-            args: [
-              ...gitFetchExtraArgs,
-              '-u',
-              '--progress',
-              `--deepen=${inputs.fetchDepth}`
-            ]
-          })
-        }
       }
     } else {
-      if (hasSubmodule && inputs.fetchSubmoduleHistory) {
+      if (diffSubmodule && inputs.fetchAdditionalSubmoduleHistory) {
         await gitFetchSubmodules({
           cwd: workingDirectory,
           args: [
@@ -427,10 +450,7 @@ export const getSHAForPullRequestEvent = async (
     }
   }
 
-  if (
-    !github.context.payload.pull_request?.base?.ref ||
-    github.context.payload.head?.repo?.fork === 'true'
-  ) {
+  if (!github.context.payload.pull_request?.base?.ref) {
     diff = '..'
   }
 
@@ -487,17 +507,14 @@ export const getSHAForPullRequestEvent = async (
         }
       }
     } else {
-      if (github.context.payload.action === 'closed') {
-        previousSha = github.context.payload.pull_request?.base?.sha
-      } else {
+      previousSha = github.context.payload.pull_request?.base?.sha
+
+      if (!previousSha) {
         previousSha = await getRemoteBranchHeadSha({
           cwd: workingDirectory,
+          remoteName,
           branch: targetBranch
         })
-
-        if (!previousSha) {
-          previousSha = github.context.payload.pull_request?.base?.sha
-        }
       }
 
       if (isShallow) {
@@ -513,7 +530,11 @@ export const getSHAForPullRequestEvent = async (
             'Merge base is not in the local history, fetching remote target branch...'
           )
 
-          for (let i = 1; i <= 10; i++) {
+          for (
+            let i = 1;
+            i <= (inputs.fetchMissingHistoryMaxRetries || 10);
+            i++
+          ) {
             await gitFetch({
               cwd: workingDirectory,
               args: [
@@ -521,8 +542,8 @@ export const getSHAForPullRequestEvent = async (
                 '-u',
                 '--progress',
                 `--deepen=${inputs.fetchDepth}`,
-                'origin',
-                `+refs/heads/${targetBranch}:refs/remotes/origin/${targetBranch}`
+                remoteName,
+                `+refs/heads/${targetBranch}:refs/remotes/${remoteName}/${targetBranch}`
               ]
             })
 

src/constant.ts

@@ -0,0 +1,29 @@
+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,
+  excludeSubmodules: false,
+  fetchMissingHistoryMaxRetries: 20,
+  usePosixPathSeparator: false,
+  tagsPattern: '*',
+  tagsIgnorePattern: ''
+}

src/env.ts

@@ -1,13 +1,10 @@
-import * as core from '@actions/core'
-
 export type Env = {
   GITHUB_REF_NAME: string
   GITHUB_REF: string
   GITHUB_WORKSPACE: string
 }
-export const getEnv = async (): Promise<Env> => {
-  core.debug(`Process Env: ${JSON.stringify(process.env, null, 2)}`)
 
+export const getEnv = async (): Promise<Env> => {
   return {
     GITHUB_REF_NAME: process.env.GITHUB_REF_NAME || '',
     GITHUB_REF: process.env.GITHUB_REF || '',

src/inputs.ts

@@ -24,7 +24,7 @@ export type Inputs = {
   since: string
   until: string
   path: string
-  quotePath: boolean
+  quotepath: boolean
   diffRelative: boolean
   dirNames: boolean
   dirNamesMaxDepth?: number
@@ -34,8 +34,9 @@ export type Inputs = {
   dirNamesDeletedFilesIncludeOnlyDeletedDirs: boolean
   json: boolean
   escapeJson: boolean
+  safeOutput: boolean
   fetchDepth?: number
-  fetchSubmoduleHistory: boolean
+  fetchAdditionalSubmoduleHistory: boolean
   sinceLastRemoteCommit: boolean
   writeOutputFiles: boolean
   outputDir: string
@@ -52,6 +53,12 @@ export type Inputs = {
   failOnInitialDiffError: boolean
   failOnSubmoduleDiffError: boolean
   negationPatternsFirst: boolean
+  useRestApi: boolean
+  excludeSubmodules: boolean
+  fetchMissingHistoryMaxRetries?: number
+  usePosixPathSeparator: boolean
+  tagsPattern: string
+  tagsIgnorePattern?: string
 }
 
 export const getInputs = (): Inputs => {
@@ -130,7 +137,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', {
@@ -152,8 +159,16 @@ export const getInputs = (): Inputs => {
       trimWhitespace: false
     }
   )
-  const json = core.getBooleanInput('json', {required: false})
-  const escapeJson = core.getBooleanInput('escape_json', {required: false})
+  let json = core.getBooleanInput('json', {required: false})
+  let escapeJson = core.getBooleanInput('escape_json', {required: false})
+  const matrix = core.getBooleanInput('matrix', {required: false})
+
+  if (matrix) {
+    json = true
+    escapeJson = false
+  }
+
+  const safeOutput = core.getBooleanInput('safe_output', {required: false})
   const fetchDepth = core.getInput('fetch_depth', {required: false})
   const sinceLastRemoteCommit = core.getBooleanInput(
     'since_last_remote_commit',
@@ -194,7 +209,7 @@ export const getInputs = (): Inputs => {
   const skipInitialFetch = core.getBooleanInput('skip_initial_fetch', {
     required: false
   })
-  const fetchSubmoduleHistory = core.getBooleanInput(
+  const fetchAdditionalSubmoduleHistory = core.getBooleanInput(
     'fetch_additional_submodule_history',
     {
       required: false
@@ -226,6 +241,35 @@ export const getInputs = (): Inputs => {
     }
   )
 
+  const useRestApi = core.getBooleanInput('use_rest_api', {
+    required: false
+  })
+
+  const excludeSubmodules = core.getBooleanInput('exclude_submodules', {
+    required: false
+  })
+
+  const fetchMissingHistoryMaxRetries = core.getInput(
+    'fetch_missing_history_max_retries',
+    {required: false}
+  )
+
+  const usePosixPathSeparator = core.getBooleanInput(
+    'use_posix_path_separator',
+    {
+      required: false
+    }
+  )
+
+  const tagsPattern = core.getInput('tags_pattern', {
+    required: false,
+    trimWhitespace: false
+  })
+  const tagsIgnorePattern = core.getInput('tags_ignore_pattern', {
+    required: false,
+    trimWhitespace: false
+  })
+
   const inputs: Inputs = {
     files,
     filesSeparator,
@@ -250,7 +294,7 @@ export const getInputs = (): Inputs => {
     since,
     until,
     path,
-    quotePath,
+    quotepath,
     diffRelative,
     sinceLastRemoteCommit,
     recoverDeletedFiles,
@@ -263,8 +307,12 @@ export const getInputs = (): Inputs => {
     oldNewSeparator,
     oldNewFilesSeparator,
     skipInitialFetch,
-    fetchSubmoduleHistory,
+    fetchAdditionalSubmoduleHistory,
     dirNamesDeletedFilesIncludeOnlyDeletedDirs,
+    excludeSubmodules,
+    usePosixPathSeparator,
+    tagsPattern,
+    tagsIgnorePattern,
     // End Not Supported via REST API
     dirNames,
     dirNamesExcludeCurrentDir,
@@ -272,15 +320,18 @@ export const getInputs = (): Inputs => {
     dirNamesIncludeFilesSeparator,
     json,
     escapeJson,
+    safeOutput,
     writeOutputFiles,
     outputDir,
     outputRenamedFilesAsDeletedAndAdded,
     token,
     apiUrl,
-    negationPatternsFirst
+    negationPatternsFirst,
+    useRestApi
   }
 
   if (fetchDepth) {
+    // Fallback to at least 2 if the fetch_depth is less than 2
     inputs.fetchDepth = Math.max(parseInt(fetchDepth, 10), 2)
   }
 
@@ -288,5 +339,13 @@ export const getInputs = (): Inputs => {
     inputs.dirNamesMaxDepth = parseInt(dirNamesMaxDepth, 10)
   }
 
+  if (fetchMissingHistoryMaxRetries) {
+    // Fallback to at least 1 if the fetch_missing_history_max_retries is less than 1
+    inputs.fetchMissingHistoryMaxRetries = Math.max(
+      parseInt(fetchMissingHistoryMaxRetries, 10),
+      1
+    )
+  }
+
   return inputs
 }

src/main.ts

@@ -26,7 +26,8 @@ import {
   setOutput,
   submoduleExists,
   updateGitGlobalConfig,
-  verifyMinimumGitVersion
+  verifyMinimumGitVersion,
+  warnUnsupportedRESTAPIInputs
 } from './utils'
 
 const getChangedFilesFromLocalGitHistory = async ({
@@ -44,15 +45,15 @@ const getChangedFilesFromLocalGitHistory = async ({
 }): Promise<void> => {
   await verifyMinimumGitVersion()
 
-  let quotePathValue = 'on'
+  let quotepathValue = 'on'
 
-  if (!inputs.quotePath) {
-    quotePathValue = 'off'
+  if (!inputs.quotepath) {
+    quotepathValue = 'off'
   }
 
   await updateGitGlobalConfig({
     name: 'core.quotepath',
-    value: quotePathValue
+    value: quotepathValue
   })
 
   if (inputs.diffRelative) {
@@ -63,14 +64,26 @@ const getChangedFilesFromLocalGitHistory = async ({
   }
 
   const isShallow = await isRepoShallow({cwd: workingDirectory})
-  const hasSubmodule = await submoduleExists({cwd: workingDirectory})
-  let gitFetchExtraArgs = ['--no-tags', '--prune', '--recurse-submodules']
+  let diffSubmodule = false
+  let gitFetchExtraArgs = ['--no-tags', '--prune']
+
+  if (inputs.excludeSubmodules) {
+    core.info('Excluding submodules from the diff')
+  } else {
+    diffSubmodule = await submoduleExists({cwd: workingDirectory})
+  }
+
+  if (diffSubmodule) {
+    gitFetchExtraArgs.push('--recurse-submodules')
+  }
+
   const isTag = env.GITHUB_REF?.startsWith('refs/tags/')
+  const remoteName = 'origin'
   const outputRenamedFilesAsDeletedAndAdded =
     inputs.outputRenamedFilesAsDeletedAndAdded
   let submodulePaths: string[] = []
 
-  if (hasSubmodule) {
+  if (diffSubmodule) {
     submodulePaths = await getSubmodulePath({cwd: workingDirectory})
   }
 
@@ -82,29 +95,30 @@ const getChangedFilesFromLocalGitHistory = async ({
 
   if (!github.context.payload.pull_request?.base?.ref) {
     core.info(`Running on a ${github.context.eventName || 'push'} event...`)
-    diffResult = await getSHAForNonPullRequestEvent(
+    diffResult = await getSHAForNonPullRequestEvent({
       inputs,
       env,
       workingDirectory,
       isShallow,
-      hasSubmodule,
+      diffSubmodule,
       gitFetchExtraArgs,
-      isTag
-    )
+      isTag,
+      remoteName
+    })
   } else {
     core.info(
       `Running on a ${github.context.eventName || 'pull_request'} (${
         github.context.payload.action
       }) event...`
     )
-    diffResult = await getSHAForPullRequestEvent(
+    diffResult = await getSHAForPullRequestEvent({
       inputs,
-      env,
       workingDirectory,
       isShallow,
-      hasSubmodule,
-      gitFetchExtraArgs
-    )
+      diffSubmodule,
+      gitFetchExtraArgs,
+      remoteName
+    })
   }
 
   if (diffResult.initialCommit) {
@@ -119,11 +133,11 @@ const getChangedFilesFromLocalGitHistory = async ({
 
   const allDiffFiles = await getAllDiffFiles({
     workingDirectory,
-    hasSubmodule,
+    diffSubmodule,
     diffResult,
     submodulePaths,
     outputRenamedFilesAsDeletedAndAdded,
-    fetchSubmoduleHistory: inputs.fetchSubmoduleHistory,
+    fetchAdditionalSubmoduleHistory: inputs.fetchAdditionalSubmoduleHistory,
     failOnInitialDiffError: inputs.failOnInitialDiffError,
     failOnSubmoduleDiffError: inputs.failOnSubmoduleDiffError
   })
@@ -145,7 +159,7 @@ const getChangedFilesFromLocalGitHistory = async ({
       deletedFiles: allDiffFiles[ChangeTypeEnum.Deleted],
       recoverPatterns,
       diffResult,
-      hasSubmodule,
+      diffSubmodule,
       submodulePaths
     })
   }
@@ -163,7 +177,7 @@ const getChangedFilesFromLocalGitHistory = async ({
     const allOldNewRenamedFiles = await getRenamedFiles({
       inputs,
       workingDirectory,
-      hasSubmodule,
+      diffSubmodule,
       diffResult,
       submodulePaths
     })
@@ -173,7 +187,8 @@ const getChangedFilesFromLocalGitHistory = async ({
       value: allOldNewRenamedFiles.paths,
       writeOutputFiles: inputs.writeOutputFiles,
       outputDir: inputs.outputDir,
-      json: inputs.json
+      json: inputs.json,
+      safeOutput: inputs.safeOutput
     })
     await setOutput({
       key: 'all_old_new_renamed_files_count',
@@ -219,11 +234,9 @@ export async function run(): Promise<void> {
   const inputs = getInputs()
   core.debug(`Inputs: ${JSON.stringify(inputs, null, 2)}`)
 
-  core.debug(`Github Context: ${JSON.stringify(github.context, null, 2)}`)
-
   const workingDirectory = path.resolve(
     env.GITHUB_WORKSPACE || process.cwd(),
-    inputs.path
+    inputs.useRestApi ? '.' : inputs.path
   )
   core.debug(`Working directory: ${workingDirectory}`)
 
@@ -242,35 +255,19 @@ export async function run(): Promise<void> {
   })
   core.debug(`Yaml file patterns: ${JSON.stringify(yamlFilePatterns)}`)
 
+  if (inputs.useRestApi && !github.context.payload.pull_request?.number) {
+    throw new Error(
+      "Only pull_request* events are supported when using GitHub's REST API."
+    )
+  }
+
   if (
     inputs.token &&
     github.context.payload.pull_request?.number &&
-    !hasGitDirectory
+    (!hasGitDirectory || inputs.useRestApi)
   ) {
     core.info("Using GitHub's REST API to get changed files")
-    const unsupportedInputs: (keyof Inputs)[] = [
-      'sha',
-      'baseSha',
-      'since',
-      'until',
-      'sinceLastRemoteCommit',
-      'recoverDeletedFiles',
-      'recoverDeletedFilesToDestination',
-      'recoverFiles',
-      'recoverFilesIgnore',
-      'includeAllOldNewRenamedFiles',
-      'skipInitialFetch',
-      'fetchSubmoduleHistory',
-      'dirNamesDeletedFilesIncludeOnlyDeletedDirs'
-    ]
-
-    for (const input of unsupportedInputs) {
-      if (inputs[input]) {
-        core.warning(
-          `Input "${input}" is not supported when using GitHub's REST API to get changed files`
-        )
-      }
-    }
+    await warnUnsupportedRESTAPIInputs({inputs})
     await getChangedFilesFromRESTAPI({
       inputs,
       filePatterns,
@@ -278,10 +275,9 @@ export async function run(): Promise<void> {
     })
   } else {
     if (!hasGitDirectory) {
-      core.setFailed(
-        "Can't find local .git directory. Please run actions/checkout before this action"
+      throw new Error(
+        `Unable to locate the git repository in the given path: ${workingDirectory}.\n Please run actions/checkout before this action (Make sure the 'path' input is correct).\n If you intend to use Github's REST API note that only pull_request* events are supported. Current event is "${github.context.eventName}".`
       )
-      return
     }
 
     core.info('Using local .git directory')
@@ -295,10 +291,8 @@ export async function run(): Promise<void> {
   }
 }
 
-/* istanbul ignore if */
-if (!process.env.TESTING) {
-  // eslint-disable-next-line github/no-then
-  run().catch(e => {
-    core.setFailed(e.message || e)
-  })
-}
+// 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} from 'lodash'
+import {flattenDeep, snakeCase} from 'lodash'
 import mm from 'micromatch'
 import * as path from 'path'
 import {createInterface} from 'readline'
 import {parseDocument} from 'yaml'
 import {ChangedFiles, ChangeTypeEnum} from './changedFiles'
 import {DiffResult} from './commitSha'
+import {DEFAULT_VALUES_OF_UNSUPPORTED_API_INPUTS} from './constant'
 import {Inputs} from './inputs'
 
 const MINIMUM_GIT_VERSION = '2.18.0'
@@ -32,11 +32,13 @@ export const normalizeSeparators = (p: string): string => {
 
     // Remove redundant slashes
     const isUnc = /^\\\\+[^\\]/.test(p) // e.g. \\hello
-    return (isUnc ? '\\' : '') + p.replace(/\\\\+/g, '\\') // preserve leading \\ for UNC
+    p = (isUnc ? '\\' : '') + p.replace(/\\\\+/g, '\\') // preserve leading \\ for UNC
+  } else {
+    // Remove redundant slashes on Linux/macOS
+    p = p.replace(/\/\/+/g, '/')
   }
 
-  // Remove redundant slashes
-  return p.replace(/\/\/+/g, '/')
+  return p
 }
 
 /**
@@ -171,15 +173,16 @@ async function* lineOfFileGenerator({
     input: fileStream,
     crlfDelay: Infinity
   })
-  for await (const line of rl) {
+  for await (let line of rl) {
     if (!line.startsWith('#') && line !== '') {
       if (excludedFiles) {
-        if (line.startsWith('!')) {
-          yield line
-        } else {
-          yield `!${line}`
+        line = line.startsWith('!') ? line : `!${line}`
+        if (line.endsWith(path.sep)) {
+          line = `${line}**`
         }
+        yield line
       } else {
+        line = line.endsWith(path.sep) ? `${line}**` : line
         yield line
       }
     }
@@ -285,6 +288,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 +337,7 @@ export const gitFetchSubmodules = async ({
 /**
  * Retrieves all the submodule paths
  * @param cwd - working directory
+ * @returns submodule paths
  */
 export const getSubmodulePath = async ({
   cwd
@@ -367,6 +372,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,
@@ -681,14 +687,16 @@ export const isInsideWorkTree = async ({
 
 export const getRemoteBranchHeadSha = async ({
   cwd,
-  branch
+  branch,
+  remoteName
 }: {
   cwd: string
   branch: string
+  remoteName: string
 }): Promise<string> => {
   const {stdout} = await exec.getExecOutput(
     'git',
-    ['rev-parse', `origin/${branch}`],
+    ['rev-parse', `${remoteName}/${branch}`],
     {
       cwd,
       silent: !core.isDebug()
@@ -823,41 +831,80 @@ export const cleanShaInput = async ({
 
   return stdout.trim()
 }
+
 export const getPreviousGitTag = async ({
-  cwd
+  cwd,
+  tagsPattern,
+  currentBranch,
+  tagsIgnorePattern
 }: {
   cwd: string
+  tagsPattern: string
+  currentBranch: string
+  tagsIgnorePattern?: string
 }): Promise<{tag: string; sha: string}> => {
+  const ignorePatterns: string[] = []
+  let currentShaDate: Date | null = null
+
   const {stdout} = await exec.getExecOutput(
     'git',
-    ['tag', '--sort=-creatordate'],
+    [
+      'tag',
+      '--sort=-creatordate',
+      '--format=%(refname:short)|%(objectname)|%(creatordate:iso)'
+    ],
     {
       cwd,
       silent: !core.isDebug()
     }
   )
 
-  const tags = stdout.trim().split('\n')
-
-  if (tags.length < 2) {
-    core.warning('No previous tag found')
-    return {tag: '', sha: ''}
+  if (tagsIgnorePattern) {
+    ignorePatterns.push(tagsIgnorePattern)
   }
 
-  const previousTag = tags[1]
-
-  const {stdout: stdout2} = await exec.getExecOutput(
-    'git',
-    ['rev-parse', previousTag],
-    {
-      cwd,
-      silent: !core.isDebug()
+  if (currentBranch) {
+    ignorePatterns.push(currentBranch)
+    try {
+      const {stdout: currentShaDateOutput} = await exec.getExecOutput(
+        'git',
+        ['show', '-s', '--format=%ai', currentBranch],
+        {
+          cwd,
+          silent: !core.isDebug()
+        }
+      )
+      currentShaDate = new Date(currentShaDateOutput.trim())
+    } catch (error) {
+      // Handle the case where the current branch doesn't exist
+      // This might happen in detached head state
+      core.warning(`Failed to get date for current branch ${currentBranch}`)
     }
-  )
+  }
 
-  const sha = stdout2.trim()
+  const previousTag: {tag: string; sha: string} = {tag: '', sha: ''}
 
-  return {tag: previousTag, sha}
+  const tags = stdout.trim().split('\n')
+  for (const tagData of tags) {
+    const [tag, sha, dateString] = tagData.split('|')
+    if (!mm.isMatch(tag, tagsPattern) || mm.isMatch(tag, ignorePatterns)) {
+      continue
+    }
+    const date = new Date(dateString)
+    if (currentShaDate && date >= currentShaDate) {
+      continue
+    }
+    // Found a suitable tag, no need to continue
+    previousTag.tag = tag
+    previousTag.sha = sha
+    break
+  }
+
+  if (!previousTag.tag) {
+    core.warning('No previous tag found')
+  }
+
+  return previousTag
 }
 
 export const canDiffCommits = async ({
@@ -898,7 +945,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 +1042,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 +1074,9 @@ export const getFilePatterns = async ({
       .split(inputs.filesIgnoreSeparator)
       .filter(Boolean)
       .map(p => {
-        if (!p.startsWith('!')) {
-          p = `!${p}`
+        p = p.startsWith('!') ? p : `!${p}`
+        if (p.endsWith(path.sep)) {
+          p = `${p}**`
         }
         return p
       })
@@ -1128,7 +1177,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
   }
@@ -1324,7 +1373,8 @@ export const setArrayOutput = async ({
     writeOutputFiles: inputs.writeOutputFiles,
     outputDir: inputs.outputDir,
     json: inputs.json,
-    shouldEscape: inputs.escapeJson
+    shouldEscape: inputs.escapeJson,
+    safeOutput: inputs.safeOutput
   })
 }
 
@@ -1334,7 +1384,8 @@ export const setOutput = async ({
   writeOutputFiles,
   outputDir,
   json = false,
-  shouldEscape = false
+  shouldEscape = false,
+  safeOutput = false
 }: {
   key: string
   value: string | string[] | boolean
@@ -1342,6 +1393,7 @@ export const setOutput = async ({
   outputDir: string
   json?: boolean
   shouldEscape?: boolean
+  safeOutput?: boolean
 }): Promise<void> => {
   let cleanedValue
   if (json) {
@@ -1350,6 +1402,11 @@ export const setOutput = async ({
     cleanedValue = value.toString().trim()
   }
 
+  // if safeOutput is true, escape special characters for bash shell
+  if (safeOutput) {
+    cleanedValue = cleanedValue.replace(/[^\x20-\x7E]|[:*?<>|;`$()&!]/g, '\\$&')
+  }
+
   core.setOutput(key, cleanedValue)
 
   if (writeOutputFiles) {
@@ -1397,7 +1454,7 @@ export const recoverDeletedFiles = async ({
   deletedFiles,
   recoverPatterns,
   diffResult,
-  hasSubmodule,
+  diffSubmodule,
   submodulePaths
 }: {
   inputs: Inputs
@@ -1405,7 +1462,7 @@ export const recoverDeletedFiles = async ({
   deletedFiles: string[]
   recoverPatterns: string[]
   diffResult: DiffResult
-  hasSubmodule: boolean
+  diffSubmodule: boolean
   submodulePaths: string[]
 }): Promise<void> => {
   let recoverableDeletedFiles = deletedFiles
@@ -1435,7 +1492,7 @@ export const recoverDeletedFiles = async ({
 
     const submodulePath = submodulePaths.find(p => deletedFile.startsWith(p))
 
-    if (hasSubmodule && submodulePath) {
+    if (diffSubmodule && submodulePath) {
       const submoduleShaResult = await gitSubmoduleDiffSHA({
         cwd: workingDirectory,
         parentSha1: diffResult.previousSha,
@@ -1483,6 +1540,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
 }: {
@@ -1492,3 +1555,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`
+      )
+    }
+  }
+}