Merge pull request #2 from rnsc/main

[Feature] include/exclude filters (#1)
Ana06 · Jul 27, 2021 · f0220ec · f0220ec
2 parents a2f6df8 + 58c3e15
commit f0220ec
Show file tree

Hide file tree

Showing 5 changed files with 1,550 additions and 52 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -85,12 +85,37 @@ jobs:
       - id: files
         name: Run the action
         uses: ./
+        with:
+          glob-filter: '*'
 
-      - name: Print steps context output
+      - name: Print files
         run: |
           echo 'steps.files.outputs.all=${{ steps.files.outputs.all }}'
           echo 'steps.files.outputs.added=${{ steps.files.outputs.added }}'
           echo 'steps.files.outputs.modified=${{ steps.files.outputs.modified }}'
           echo 'steps.files.outputs.removed=${{ steps.files.outputs.removed }}'
           echo 'steps.files.outputs.renamed=${{ steps.files.outputs.renamed }}'
           echo 'steps.files.outputs.added_modified=${{ steps.files.outputs.added_modified }}'
+          
+      - id: files-filtered
+        name: Run the action
+        uses: ./
+        with:
+          glob-filter: |
+            *.yml
+            !.github/*/*.yml
+            *.js
+            *.ts
+            package*
+            !*.json
+            
+
+      - name: Print files-filtered
+        run: |
+          echo 'steps.files-filtered.outputs.all=${{ steps.files-filtered.outputs.all }}'
+          echo 'steps.files-filtered.outputs.added=${{ steps.files-filtered.outputs.added }}'
+          echo 'steps.files-filtered.outputs.modified=${{ steps.files-filtered.outputs.modified }}'
+          echo 'steps.files-filtered.outputs.removed=${{ steps.files-filtered.outputs.removed }}'
+          echo 'steps.files-filtered.outputs.renamed=${{ steps.files-filtered.outputs.renamed }}'
+          echo 'steps.files-filtered.outputs.added_modified=${{ steps.files-filtered.outputs.added_modified }}'
+        
diff --git a/README.md b/README.md
@@ -1,44 +1,68 @@
+# get-changed-files
+
 [![CI status](https://github.com/Ana06/get-changed-files/workflows/Test/badge.svg)](https://github.com/Ana06/get-changed-files/actions?query=event%3Apush+branch%3Amain)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.txt)
 
-This project is a fork of https://github.com/jitterbit/get-changed-files, which supports `pull_request_target`, allow to filter files using regular expressions and removes the ahead check.
+This project is a fork of <https://github.com/jitterbit/get-changed-files>, which supports `pull_request_target`, allow to filter files using regular expressions and removes the ahead check.
 
-# Get All Changed Files
+## Get All Changed Files
 
 Get all of the files changed/modified in a pull request (`pull_request` or `pull_request_target`) or push's commits.
 You can choose to get all changed files, only added files, only modified files, only removed files, only renamed files, or all added and modified files.
 These outputs are available via the `steps` output context.
 The `steps` output context exposes the output names `all`, `added`, `modified`, `removed`, `renamed`, and `added_modified`.
 
-# Usage
+## Usage
 
 See [action.yml](action.yml)
 
 ```yaml
-- uses: Ana06/get-changed-files@v1.2
+- uses: Ana06/get-changed-files@v2.0.0
   with:
     # Format of the steps output context.
     # Can be 'space-delimited', 'csv', or 'json'.
     # Default: 'space-delimited'
     format: ''
-    # Filter files using a regex
+    # Filter files using a glob filter
     filter: '*'
 ```
 
-# Scenarios
+## Scenarios
 
-- [Get all changed files as space-delimited](#get-all-changed-files-as-space-delimited)
-- [Get all added and modified files as CSV](#get-all-added-and-modified-files-as-csv)
-- [Get all removed files as JSON](#get-all-removed-files-as-json)
+- [get-changed-files](#get-changed-files)
+  - [Get All Changed Files](#get-all-changed-files)
+  - [Usage](#usage)
+  - [Scenarios](#scenarios)
+    - [Get all changed files as space-delimited](#get-all-changed-files-as-space-delimited)
+    - [Get all changed *.php files as space-delimited](#get-all-changed-php-files-as-space-delimited)
+    - [Get all changed *.yml files but exclude .github/*/*.yml files](#get-all-changed-yml-files-but-exclude-githubyml-files)
+    - [Get all added and modified files as CSV](#get-all-added-and-modified-files-as-csv)
+    - [Get all removed files as JSON](#get-all-removed-files-as-json)
+  - [Install, Build, Lint, Test, and Package](#install-build-lint-test-and-package)
+  - [License](#license)
 
-## Get all changed files as space-delimited
+### Get all changed files as space-delimited
 
 If there are any files with spaces in them, then this method won't work and the step will fail.
 Consider using one of the other formats if that's the case.
 
 ```yaml
 - id: files
-  uses: Ana06/get-changed-files@v1.2
+  uses: Ana06/get-changed-files@v2.0.0
+- run: |
+    for changed_file in ${{ steps.files.outputs.all }}; do
+      echo "Do something with this ${changed_file}."
+    done
+```
+
+### Get all changed *.php files as space-delimited
+
+If there are any files with spaces in them, then this method won't work and the step will fail.
+Consider using one of the other formats if that's the case.
+
+```yaml
+- id: files
+  uses: Ana06/get-changed-files@v2.0.0
   with:
     filter: '*.php'
 - run: |
@@ -47,43 +71,59 @@ Consider using one of the other formats if that's the case.
     done
 ```
 
-## Get all added and modified files as CSV
+### Get all changed *.yml files but exclude .github/*/*.yml files
+
+Be careful that the order of the glob has an importance.
+Therefore, including all YML files first and excluding the YML files of your `.github/*/` directories is the way to go to exclude them.
+If those two globs were inverted, you **would** include all the YML files, with the ones in your `.github/*/` directories.
+
+```yaml
+- uses: Ana06/get-changed-files@v2.0.0
+  with:
+    filter: |
+      *.yml
+      !.github/*/*.yml
+```
+
+### Get all added and modified files as CSV
 
 ```yaml
 - id: files
-  uses: Ana06/get-changed-files@v1.2
+  uses: Ana06/get-changed-files@v2.0.0
   with:
     format: 'csv'
+    filter: '*'
 - run: |
     mapfile -d ',' -t added_modified_files < <(printf '%s,' '${{ steps.files.outputs.added_modified }}')
     for added_modified_file in "${added_modified_files[@]}"; do
       echo "Do something with this ${added_modified_file}."
     done
 ```
 
-## Get all removed files as JSON
+### Get all removed files as JSON
 
 ```yaml
 - id: files
-  uses: Ana06/get-changed-files@v1.2
+  uses: Ana06/get-changed-files@v2.0.0
   with:
     format: 'json'
+    filter: '*'
 - run: |
     readarray -t removed_files <<<"$(jq -r '.[]' <<<'${{ steps.files.outputs.removed }}')"
     for removed_file in ${removed_files[@]}; do
       echo "Do something with this ${removed_file}."
     done
 ```
 
-# Install, Build, Lint, Test, and Package
+## Install, Build, Lint, Test, and Package
 
 Make sure to do the following before checking in any code changes.
 
 ```bash
-$ yarn
-$ yarn all
+yarn
+yarn all
 ```
 
-# License
+## License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)