Updated README.md (#968)

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

.github/workflows/test.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Checkout to branch
         uses: actions/checkout@v3
       - name: shellcheck
-        uses: reviewdog/action-shellcheck@v1.16
+        uses: reviewdog/action-shellcheck@v1.17
 
   test-multiple-repositories:
     name: Test with multiple repositories
@@ -446,6 +446,28 @@ jobs:
           exit 1
         shell:
           bash
+      - name: Run changed-files with dir_names and dir_names_exclude_root
+        id: changed-files-dir-names-exclude-root
+        uses: ./
+        with:
+          base_sha: dddfbd69
+          sha: ce8c1983
+          fetch_depth: 60000
+          dir_names: "true"
+          dir_names_exclude_root: "true"
+          dir_names_max_depth: "1"
+      - name: Show output
+        run: |
+          echo '${{ toJSON(steps.changed-files-dir-names-exclude-root.outputs) }}'
+        shell:
+          bash
+      - name: Check dir_names output
+        if: steps.changed-files-dir-names-exclude-root.outputs.all_changed_files != '.github'
+        run: |
+          echo "Invalid output: Expected (.github) got (${{ steps.changed-files-dir-names-exclude-root.outputs.all_changed_files }})"
+          exit 1
+        shell:
+          bash
       - name: Run changed-files with dir_names
         id: changed-files-dir-names
         uses: ./

HISTORY.md

@@ -1,9 +1,28 @@
 # Changelog
 
+## [v35.4.4](https://github.com/tj-actions/changed-files/tree/v35.4.4) (2023-01-19)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v35...v35.4.4)
+
 ## [v35](https://github.com/tj-actions/changed-files/tree/v35) (2023-01-19)
 
 [Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.4.3...v35)
 
+**Fixed bugs:**
+
+- \[BUG\] Action is evaluating branch instead of sha [\#957](https://github.com/tj-actions/changed-files/issues/957)
+- \[BUG\] Unable to run on windows self-hosted runner [\#956](https://github.com/tj-actions/changed-files/issues/956)
+
+**Closed issues:**
+
+- Comparing differences between tags/releases [\#949](https://github.com/tj-actions/changed-files/issues/949)
+
+**Merged pull requests:**
+
+- fix: revert change to pull pr branch via the branch name [\#958](https://github.com/tj-actions/changed-files/pull/958) ([jackton1](https://github.com/jackton1))
+- feat: add guide for retrieving  changed files for tags [\#955](https://github.com/tj-actions/changed-files/pull/955) ([jackton1](https://github.com/jackton1))
+- Upgraded to v35.4.3 [\#954](https://github.com/tj-actions/changed-files/pull/954) ([jackton1](https://github.com/jackton1))
+
 ## [v35.4.3](https://github.com/tj-actions/changed-files/tree/v35.4.3) (2023-01-19)
 
 [Full Changelog](https://github.com/tj-actions/changed-files/compare/v35.4.2...v35.4.3)
@@ -445,7 +464,7 @@
 
 ## [v34.3.3](https://github.com/tj-actions/changed-files/tree/v34.3.3) (2022-11-08)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.3.2...v34.3.3)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.3.1...v34.3.3)
 
 **Fixed bugs:**
 
@@ -460,13 +479,13 @@
 - chore: update readme [\#784](https://github.com/tj-actions/changed-files/pull/784) ([jackton1](https://github.com/jackton1))
 - Upgraded to v34.3.2 [\#781](https://github.com/tj-actions/changed-files/pull/781) ([jackton1](https://github.com/jackton1))
 
-## [v34.3.2](https://github.com/tj-actions/changed-files/tree/v34.3.2) (2022-11-07)
-
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.3.1...v34.3.2)
-
 ## [v34.3.1](https://github.com/tj-actions/changed-files/tree/v34.3.1) (2022-11-07)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.3.0...v34.3.1)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.3.2...v34.3.1)
+
+## [v34.3.2](https://github.com/tj-actions/changed-files/tree/v34.3.2) (2022-11-07)
+
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v34.3.0...v34.3.2)
 
 **Fixed bugs:**
 
@@ -799,7 +818,7 @@
 
 ## [v31.0.0](https://github.com/tj-actions/changed-files/tree/v31.0.0) (2022-09-25)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v30.0.0...v31.0.0)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v30...v31.0.0)
 
 **Merged pull requests:**
 
@@ -812,13 +831,13 @@
 - chore: update broken link [\#642](https://github.com/tj-actions/changed-files/pull/642) ([jackton1](https://github.com/jackton1))
 - Upgraded to v30.0.0 [\#641](https://github.com/tj-actions/changed-files/pull/641) ([jackton1](https://github.com/jackton1))
 
-## [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/v30...v30.0.0)
-
 ## [v30](https://github.com/tj-actions/changed-files/tree/v30) (2022-09-24)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v29.0.9...v30)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v30.0.0...v30)
+
+## [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)
 
 **Fixed bugs:**
 
@@ -1699,7 +1718,7 @@
 
 ## [v13](https://github.com/tj-actions/changed-files/tree/v13) (2022-02-17)
 
-[Full Changelog](https://github.com/tj-actions/changed-files/compare/v12.2...v13)
+[Full Changelog](https://github.com/tj-actions/changed-files/compare/v2.0.1...v13)
 
 **Implemented enhancements:**
 
@@ -1718,13 +1737,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)
 
-## [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/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)
+[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)
 
 **Merged pull requests:**
 

README.md

@@ -26,7 +26,7 @@ Retrieve all changed files and directories relative to the target branch or the
 *   Escaped JSON Output which can be used for running matrix jobs based on changed files.
 *   Optionally list only changed directories.
 *   Restrict the max depth of changed directories.
-*   Optionally save outputs to files at a specified location for further processing.
+*   Write outputs to files at a specified location for further processing.
 *   Monorepos (Fetches only the last remote commit).
 *   Supports all platforms (Linux, MacOS, Windows).
 *   [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners) support
@@ -98,6 +98,21 @@ jobs:
         run: |
           echo "One or more files in the docs folder has changed."
           echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}"
+      
+      # Example 3
+      - name: Get changed js files excluding the docs folder
+        id: changed-files-excluded
+        uses: tj-actions/changed-files@v35
+        with:
+          files: |
+            **/*.js
+          files_ignore: docs/** # Alternatively using: `docs`
+
+      - name: Run step if any other js file(s) change
+        if: steps.changed-files-excluded.outputs.any_changed == 'true'
+        run: |
+          echo "One or more js files not in the doc folder has changed."
+          echo "List all the files that have changed: ${{ steps.changed-files-excluded.outputs.all_changed_files }}"
 ```
 
 If you feel generous and want to show some extra appreciation:
@@ -162,6 +177,7 @@ Support this project with a :star:
 |             base\_sha              | string |  false   |                     |                                                                                      Specify a different base commit SHA<br>used for comparing changes                                                                                      |
 |           diff\_relative           | string |  false   |                     |                            Exclude changes outside the current directory<br> and show path names relative to<br> it. **NOTE:** This requires you to<br> specify the top level directory via<br>the `path` input.                            |
 |             dir\_names             | string |  false   |      `"false"`      |                                             Output unique changed directories instead of<br> filenames. **NOTE:** This returns `.` for<br> changed files located in the root<br>of the project.                                             |
+|      dir\_names\_exclude\_root       | string |  false   |      `"false"`      |                                                                   Exclude the root directory represented by<br> `.` from the output when `dir_names`is<br>set to `true`.                                                                    |
 |        dir\_names\_max\_depth        | string |  false   |                     |                                                              Maximum depth of directories to output.<br> e.g `test/test1/test2` with max depth of<br>`2` returns `test/test1`.                                                              |
 |            fetch\_depth            | string |  false   |       `"50"`        |                                                       Depth of additional branch history fetched.<br> **NOTE**: This can be adjusted to<br>resolve errors with insufficient history.                                                        |
 |               files               | string |  false   |                     |                     File and directory patterns to detect<br> changes using only these list of<br> file(s) (Defaults to the entire repo)<br> **NOTE:** Multiline file/directory patterns should not<br>include quotes.                      |

action.yml

@@ -75,6 +75,10 @@ inputs:
   dir_names_max_depth:
     description: "Maximum depth of directories to output. e.g `test/test1/test2` with max depth of `2` returns `test/test1`."
     required: false
+  dir_names_exclude_root:
+    description: "Exclude the root directory represented by `.` from the output when `dir_names`is set to `true`."
+    required: false
+    default: "false"
   json:
     description: "Output list of changed files in a JSON formatted string which can be used for matrix jobs."
     required: false
@@ -245,6 +249,7 @@ runs:
         INPUT_DIFF_RELATIVE: ${{ inputs.diff_relative }}
         INPUT_DIR_NAMES: ${{ inputs.dir_names }}
         INPUT_DIR_NAMES_MAX_DEPTH: ${{ inputs.dir_names_max_depth }}
+        INPUT_DIR_NAMES_EXCLUDE_ROOT: ${{ inputs.dir_names_exclude_root }}
         INPUT_JSON: ${{ inputs.json }}
         INPUT_HAS_CUSTOM_PATTERNS: ${{ steps.glob.outputs.has-custom-patterns }}
         INPUT_JSON_RAW_FORMAT: ${{ inputs.json_raw_format }}

diff-sha.sh

@@ -12,9 +12,6 @@ IS_TAG="false"
 
 if [[ "$GITHUB_REF" == "refs/tags/"* ]]; then
   IS_TAG="true"
-fi
-
-if [[ "$GITHUB_REF" == "refs/tags/"* ]]; then
   EXTRA_ARGS="--prune --no-recurse-submodules"
 fi
 

get-changed-paths.sh

@@ -47,6 +47,10 @@ function get_dirname_max_depth() {
       depth=$((depth + 1))
     done
 
+    if [[ "$INPUT_DIR_NAMES_EXCLUDE_ROOT" == "true" && "$output" == "." ]]; then
+      continue
+    fi
+
     echo "$output"
   done < <(uniq)
 }