Make example consistent and out of the box usable (#931)

Co-authored-by: Tonye Jack <jtonye@ymail.com>

.all-contributorsrc

@@ -169,6 +169,15 @@
         "code",
         "doc"
       ]
+    },
+    {
+      "login": "cfernhout",
+      "name": "Chiel Fernhout",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22294606?v=4",
+      "profile": "https://github.com/cfernhout",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/manual-test.yml

@@ -3,6 +3,7 @@ name: Manual Test
 on:
   workflow_dispatch:
 
+
 jobs:
   test:
     name: Test changed-files

.github/workflows/test.yml

@@ -3,7 +3,6 @@ name: CI
 on:
   push:
     branches:
-      - main
       - "**"
   pull_request:
     types:

.github/workflows/update-readme.yml

@@ -9,7 +9,7 @@ jobs:
   sync-assets:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.2.0
+      - uses: actions/checkout@v3.3.0
         with:
           fetch-depth: 0
 

HISTORY.md

@@ -1,16 +1,20 @@
 # Changelog
 
-## [v35.2.1](https://github.com/tj-actions/changed-files/tree/v35.2.1) (2023-01-02)
+## [Unreleased](https://github.com/tj-actions/changed-files/tree/HEAD)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35...v35.2.1)
-
-## [v35](https://github.com/tj-actions/changed-files/tree/v35) (2023-01-02)
-
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.2.0...v35)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.3.2...HEAD)
 
 **Fixed bugs:**
 
-- \[BUG\] On pull\_request\_review error [\#906](https://github.com/tj-actions/changed-files/issues/906)
+- \[BUG\] v35.3.0 Fails to add \[\] around files when with:json: true [\#926](https://github.com/tj-actions/changed-files/issues/926)
+
+## [v35.3.2](https://github.com/tj-actions/changed-files/tree/v35.3.2) (2023-01-05)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35...v35.3.2)
+
+## [v35](https://github.com/tj-actions/changed-files/tree/v35) (2023-01-05)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.3.1...v35)
 
 **Closed issues:**
 
@@ -18,6 +22,45 @@
 
 **Merged pull requests:**
 
+- fix\(regression\): invalid json output. [\#930](https://github.com/tj-actions/changed-files/pull/930) ([jackton1](https://github.com/jackton1))
+- chore\(deps\): update actions/checkout action to v3.3.0 [\#929](https://github.com/tj-actions/changed-files/pull/929) ([renovate[bot]](https://github.com/apps/renovate))
+- Upgraded to v35.3.1 [\#928](https://github.com/tj-actions/changed-files/pull/928) ([jackton1](https://github.com/jackton1))
+
+## [v35.3.1](https://github.com/tj-actions/changed-files/tree/v35.3.1) (2023-01-05)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.3.0...v35.3.1)
+
+**Fixed bugs:**
+
+- \[BUG\] `files_ignore` used with `files` not ignoring as expected [\#901](https://github.com/tj-actions/changed-files/issues/901)
+
+**Merged pull requests:**
+
+- fix: json output [\#927](https://github.com/tj-actions/changed-files/pull/927) ([jackton1](https://github.com/jackton1))
+- Upgraded to v35.3.0 [\#925](https://github.com/tj-actions/changed-files/pull/925) ([jackton1](https://github.com/jackton1))
+
+## [v35.3.0](https://github.com/tj-actions/changed-files/tree/v35.3.0) (2023-01-05)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.2.1...v35.3.0)
+
+**Merged pull requests:**
+
+- fix: bug dirnames output [\#923](https://github.com/tj-actions/changed-files/pull/923) ([jackton1](https://github.com/jackton1))
+- chore\(deps\): update tj-actions/auto-doc action to v1.7.3 [\#922](https://github.com/tj-actions/changed-files/pull/922) ([renovate[bot]](https://github.com/apps/renovate))
+- Updated README.md [\#921](https://github.com/tj-actions/changed-files/pull/921) ([jackton1](https://github.com/jackton1))
+- Updated README.md [\#920](https://github.com/tj-actions/changed-files/pull/920) ([jackton1](https://github.com/jackton1))
+- Upgraded to v35.2.1 [\#919](https://github.com/tj-actions/changed-files/pull/919) ([jackton1](https://github.com/jackton1))
+
+## [v35.2.1](https://github.com/tj-actions/changed-files/tree/v35.2.1) (2023-01-02)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.2.0...v35.2.1)
+
+**Fixed bugs:**
+
+- \[BUG\] On pull\_request\_review error [\#906](https://github.com/tj-actions/changed-files/issues/906)
+
+**Merged pull requests:**
+
 - Updated README.md [\#918](https://github.com/tj-actions/changed-files/pull/918) ([jackton1](https://github.com/jackton1))
 - Bump tj-actions/auto-doc from 1.7.1 to 1.7.2 [\#917](https://github.com/tj-actions/changed-files/pull/917) ([dependabot[bot]](https://github.com/apps/dependabot))
 - chore: update readme [\#916](https://github.com/tj-actions/changed-files/pull/916) ([jackton1](https://github.com/jackton1))
@@ -32,10 +75,6 @@
 
 [Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.1.2...v35.2.0)
 
-**Fixed bugs:**
-
-- \[BUG\] `files_ignore` used with `files` not ignoring as expected [\#901](https://github.com/tj-actions/changed-files/issues/901)
-
 **Merged pull requests:**
 
 - chore: update the test [\#909](https://github.com/tj-actions/changed-files/pull/909) ([jackton1](https://github.com/jackton1))
@@ -104,7 +143,7 @@
 
 ## [v35.0.0](https://github.com/tj-actions/changed-files/tree/v35.0.0) (2022-12-19)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.6.2...v35.0.0)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34...v35.0.0)
 
 **Fixed bugs:**
 
@@ -122,13 +161,13 @@
 - fix: fail when the merge base is not found [\#879](https://github.com/tj-actions/changed-files/pull/879) ([jackton1](https://github.com/jackton1))
 - Upgraded to v34.6.2 [\#878](https://github.com/tj-actions/changed-files/pull/878) ([jackton1](https://github.com/jackton1))
 
-## [v34.6.2](https://github.com/tj-actions/changed-files/tree/v34.6.2) (2022-12-16)
-
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34...v34.6.2)
-
 ## [v34](https://github.com/tj-actions/changed-files/tree/v34) (2022-12-16)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.6.1...v34)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.6.2...v34)
+
+## [v34.6.2](https://github.com/tj-actions/changed-files/tree/v34.6.2) (2022-12-16)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.6.1...v34.6.2)
 
 **Fixed bugs:**
 
@@ -547,7 +586,7 @@
 
 ## [v34.0.0](https://github.com/tj-actions/changed-files/tree/v34.0.0) (2022-10-25)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v33...v34.0.0)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v33.0.0...v34.0.0)
 
 **Fixed bugs:**
 
@@ -560,13 +599,13 @@
 - feat: add support for fetching more history [\#709](https://github.com/tj-actions/changed-files/pull/709) ([jackton1](https://github.com/jackton1))
 - Upgraded to v33.0.0 [\#707](https://github.com/tj-actions/changed-files/pull/707) ([jackton1](https://github.com/jackton1))
 
-## [v33](https://github.com/tj-actions/changed-files/tree/v33) (2022-10-21)
-
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v33.0.0...v33)
-
 ## [v33.0.0](https://github.com/tj-actions/changed-files/tree/v33.0.0) (2022-10-21)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v32.1.2...v33.0.0)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v33...v33.0.0)
+
+## [v33](https://github.com/tj-actions/changed-files/tree/v33) (2022-10-21)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v32.1.2...v33)
 
 **Closed issues:**
 
@@ -723,7 +762,7 @@
 
 ## [v30.0.0](https://github.com/tj-actions/changed-files/tree/v30.0.0) (2022-09-24)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v29.0.9...v30.0.0)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v29...v30.0.0)
 
 **Fixed bugs:**
 
@@ -739,13 +778,13 @@
 - chore\(deps\): update codacy/codacy-analysis-cli-action action to v4.2.0 [\#634](https://github.com/tj-actions/changed-files/pull/634) ([renovate[bot]](https://github.com/apps/renovate))
 - Upgraded to v29.0.9 [\#633](https://github.com/tj-actions/changed-files/pull/633) ([jackton1](https://github.com/jackton1))
 
-## [v29.0.9](https://github.com/tj-actions/changed-files/tree/v29.0.9) (2022-09-20)
-
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v29...v29.0.9)
-
 ## [v29](https://github.com/tj-actions/changed-files/tree/v29) (2022-09-20)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v29.0.8...v29)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v29.0.9...v29)
+
+## [v29.0.9](https://github.com/tj-actions/changed-files/tree/v29.0.9) (2022-09-20)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v29.0.8...v29.0.9)
 
 **Implemented enhancements:**
 
@@ -1604,7 +1643,7 @@
 
 ## [v13](https://github.com/tj-actions/changed-files/tree/v13) (2022-02-17)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v2.0.1...v13)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v12.2...v13)
 
 **Implemented enhancements:**
 
@@ -1623,13 +1662,13 @@
 - \[BUG\] wrong result of any\_change output [\#314](https://github.com/tj-actions/changed-files/issues/314)
 - \[BUG\] Investigate possible bug using since\_last\_remote\_commit when force pushing changes. [\#303](https://github.com/tj-actions/changed-files/issues/303)
 
-## [v2.0.1](https://github.com/tj-actions/changed-files/tree/v2.0.1) (2021-12-30)
-
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v12.2...v2.0.1)
-
 ## [v12.2](https://github.com/tj-actions/changed-files/tree/v12.2) (2021-12-30)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v12.1...v12.2)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v2.0.1...v12.2)
+
+## [v2.0.1](https://github.com/tj-actions/changed-files/tree/v2.0.1) (2021-12-30)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v12.1...v2.0.1)
 
 **Merged pull requests:**
 

README.md

@@ -9,7 +9,7 @@
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 
-[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-19-orange.svg?style=flat-square)](#contributors-)
 
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
@@ -47,7 +47,7 @@ Retrieve all changed files and directories relative to the target branch or the
 > *   For monorepos where pulling all the branch history might not be desired, you can omit `fetch-depth` for `pull_request` events.
 > *   For files located in a sub-directory ensure that the pattern specified contains `**/` (globstar) to match any preceding directories or explicitly pass the full path relative to the project root. See: [#314](https://github.com/tj-actions/changed-files/issues/314).
 > *   All multiline inputs should not use double or single qoutes since the value is already a string seperated by a newline character. See [Examples](#examples) for more information.
-> *   Ensure that `persist-credentials` is set to `true` when configuring `actions/checkout`.
+> *   Ensure that `persist-credentials` is set to `true` when configuring `actions/checkout` if `fetch-depth` isn't set to `0`.
 
 ```yaml
 name: CI
@@ -64,7 +64,6 @@ on:
     branches:
       - main
 
-
 jobs:
   build:
     runs-on: ubuntu-latest  # windows-latest | macos-latest
@@ -290,7 +289,7 @@ See [inputs](#inputs) for more information.
 ```yaml
 ...
     - name: Get changed files
-      id: changed-files
+      id: changed-files-specific
       uses: tj-actions/changed-files@v35
       with:
         files: |
@@ -312,16 +311,16 @@ See [inputs](#inputs) for more information.
         echo "Only files listed above have changed."
 
     - name: Run step if any of the listed files above is deleted
-      if: steps.changed-files.outputs.any_deleted == 'true'
+      if: steps.changed-files-specific.outputs.any_deleted == 'true'
       run: |
-        for file in ${{ steps.changed-files.outputs.deleted_files }}; do
+        for file in ${{ steps.changed-files-specific.outputs.deleted_files }}; do
           echo "$file was deleted"
         done
 
     - name: Run step if all listed files above have been deleted
-      if: steps.changed-files.outputs.only_deleted == 'true'
+      if: steps.changed-files-specific.outputs.only_deleted == 'true'
       run: |
-        for file in ${{ steps.changed-files.outputs.deleted_files }}; do
+        for file in ${{ steps.changed-files-specific.outputs.deleted_files }}; do
           echo "$file was deleted"
         done
 ...
@@ -687,6 +686,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center"><a href="https://github.com/lpulley"><img src="https://avatars.githubusercontent.com/u/7193187?v=4?s=100" width="100px;" alt="Logan Pulley"/><br /><sub><b>Logan Pulley</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=lpulley" title="Code">💻</a></td>
       <td align="center"><a href="https://www.linkedin.com/in/kenji-miyake/"><img src="https://avatars.githubusercontent.com/u/31987104?v=4?s=100" width="100px;" alt="Kenji Miyake"/><br /><sub><b>Kenji Miyake</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=kenji-miyake" title="Code">💻</a></td>
       <td align="center"><a href="https://github.com/adonisgarciac"><img src="https://avatars.githubusercontent.com/u/71078987?v=4?s=100" width="100px;" alt="adonisgarciac"/><br /><sub><b>adonisgarciac</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=adonisgarciac" title="Code">💻</a> <a href="https://github.com/tj-actions/changed-files/commits?author=adonisgarciac" title="Documentation">📖</a></td>
+      <td align="center"><a href="https://github.com/cfernhout"><img src="https://avatars.githubusercontent.com/u/22294606?v=4?s=100" width="100px;" alt="Chiel Fernhout"/><br /><sub><b>Chiel Fernhout</b></sub></a><br /><a href="https://github.com/tj-actions/changed-files/commits?author=cfernhout" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

diff-sha.sh

@@ -54,11 +54,12 @@ if [[ -z $GITHUB_EVENT_PULL_REQUEST_BASE_REF ]]; then
   echo "Running on a push event..."
   TARGET_BRANCH=$GITHUB_REFNAME
   CURRENT_BRANCH=$TARGET_BRANCH
-  
-  echo "Fetching remote refs..."
-  
-  # shellcheck disable=SC2086
-  git fetch $EXTRA_ARGS -u --progress --deepen="$INPUT_FETCH_DEPTH" origin "$CURRENT_BRANCH" 1>/dev/null
+
+  if [[ -f .git/shallow ]]; then
+    echo "Fetching remote refs..."
+    # shellcheck disable=SC2086
+    git fetch $EXTRA_ARGS -u --progress --deepen="$INPUT_FETCH_DEPTH" origin "$CURRENT_BRANCH" 1>/dev/null
+  fi
 
   echo "::debug::Getting HEAD SHA..."
   if [[ -n "$INPUT_UNTIL" ]]; then
@@ -157,9 +158,11 @@ else
     TARGET_BRANCH=$CURRENT_BRANCH
   fi
 
-  echo "Fetching remote refs..."
-  # shellcheck disable=SC2086
-  git fetch $EXTRA_ARGS -u --progress origin pull/"$GITHUB_EVENT_PULL_REQUEST_NUMBER"/head:"$CURRENT_BRANCH" 1>/dev/null
+  if [[ -f .git/shallow ]]; then
+    echo "Fetching remote refs..."
+    # shellcheck disable=SC2086
+    git fetch $EXTRA_ARGS -u --progress origin pull/"$GITHUB_EVENT_PULL_REQUEST_NUMBER"/head:"$CURRENT_BRANCH" 1>/dev/null
+  fi
 
   echo "::debug::Getting HEAD SHA..."
   if [[ -n "$INPUT_UNTIL" ]]; then
@@ -197,9 +200,11 @@ else
         PREVIOUS_SHA=$GITHUB_EVENT_PULL_REQUEST_BASE_SHA
       fi
     else
-      echo "::debug::Fetching remote target branch..."
-      # shellcheck disable=SC2086
-      git fetch -u --progress $EXTRA_ARGS --depth="$INPUT_FETCH_DEPTH" origin +refs/heads/"$TARGET_BRANCH":refs/remotes/origin/"$TARGET_BRANCH" 1>/dev/null
+      if [[ -f .git/shallow ]]; then
+        echo "::debug::Fetching remote target branch..."
+        # shellcheck disable=SC2086
+        git fetch -u --progress $EXTRA_ARGS --depth="$INPUT_FETCH_DEPTH" origin +refs/heads/"$TARGET_BRANCH":refs/remotes/origin/"$TARGET_BRANCH" 1>/dev/null
+      fi
 
       git branch --track "$TARGET_BRANCH" origin/"$TARGET_BRANCH" 1>/dev/null 2>&1 || true
 
@@ -210,21 +215,16 @@ else
       PREVIOUS_SHA=$GITHUB_EVENT_PULL_REQUEST_BASE_SHA && exit_status=$? || exit_status=$?
     fi
 
+    if ! git diff --name-only --ignore-submodules=all "$PREVIOUS_SHA$DIFF$CURRENT_SHA" 1>/dev/null 2>&1; then
+        PREVIOUS_SHA=$(git rev-parse "$TARGET_BRANCH") && exit_status=$? || exit_status=$?
+        DIFF=".."
+    fi
+
     echo "::debug::Previous SHA: $PREVIOUS_SHA"
   else
     PREVIOUS_SHA=$INPUT_BASE_SHA && exit_status=$? || exit_status=$?
   fi
 
-  if ! git diff --name-only --ignore-submodules=all "$PREVIOUS_SHA$DIFF$CURRENT_SHA" 1>/dev/null 2>&1; then
-    PREVIOUS_SHA=$(git rev-parse "$TARGET_BRANCH") && exit_status=$? || exit_status=$?
-    DIFF=".."
-
-    if ! git diff --name-only --ignore-submodules=all "$PREVIOUS_SHA$DIFF$CURRENT_SHA" 1>/dev/null 2>&1; then
-      echo "::error::Unable find a diff between $PREVIOUS_SHA and $CURRENT_SHA"
-      exit 1
-    fi
-  fi
-
   echo "::debug::Target branch: $TARGET_BRANCH"
   echo "::debug::Current branch: $CURRENT_BRANCH"
 
@@ -236,6 +236,11 @@ else
     echo "::error::Please verify that the previous sha is valid, and increase the fetch_depth to a number higher than $INPUT_FETCH_DEPTH."
     exit 1
   fi
+
+  if ! git diff --name-only --ignore-submodules=all "$PREVIOUS_SHA$DIFF$CURRENT_SHA" 1>/dev/null 2>&1; then
+    echo "::error::Unable find a diff between $PREVIOUS_SHA and $CURRENT_SHA"
+    exit 1
+  fi
 fi
 
 if [[ "$PREVIOUS_SHA" == "$CURRENT_SHA" && "$INITIAL_COMMIT" == "false" ]]; then

get-changed-paths.sh

@@ -52,13 +52,13 @@ function get_dirname_max_depth() {
 }
 
 function json_output() {
-  JQ_ARGS="-R"
+  JQ_ARGS="-sR"
   if [[ "$INPUT_JSON_RAW_FORMAT" == "true" ]]; then
     JQ_ARGS="$JQ_ARGS -r"
   fi
 
   # shellcheck disable=SC2086
-  jq $JQ_ARGS '@json' | tr "\n" " " | sed "s| $||g"
+  jq $JQ_ARGS 'split("\n") | map(select(. != "")) | @json' | sed -r 's/^"|"$//g' | tr -s /
 }
 
 function get_diff() {

test/test/test.txt

@@ -1 +1 @@
-This is a test file
+This is a test file.