Use picomatch + impl followups from #48

Merge pull request #48 from getsentry/master
feat: Add support for multiple patterns when using file status
2025-12-25 16:38:20 +00:00 · 2020-11-09 00:45:53 +01:00 · 2020-11-09 00:26:00 +01:00 · 2020-11-06 17:41:51 -08:00 · 2020-11-03 09:23:07 +01:00 · 2020-10-23 12:33:44 +02:00
24 changed files with 15481 additions and 3625 deletions
--- a/.editorconfig
+++ b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -25,7 +25,7 @@
      "@typescript-eslint/generic-type-naming": ["error", "^[A-Z][A-Za-z]*$"],
      "@typescript-eslint/no-array-constructor": "error",
      "@typescript-eslint/no-empty-interface": "error",
-      "@typescript-eslint/no-explicit-any": "error",
+      "@typescript-eslint/no-explicit-any": "off",
      "@typescript-eslint/no-extraneous-class": "error",
      "@typescript-eslint/no-for-in-array": "error",
      "@typescript-eslint/no-inferrable-types": "error",
@@ -42,7 +42,7 @@
      "@typescript-eslint/prefer-includes": "error",
      "@typescript-eslint/prefer-interface": "error",
      "@typescript-eslint/prefer-string-starts-ends-with": "error",
-      "@typescript-eslint/promise-function-async": "error",
+      "@typescript-eslint/promise-function-async": ["error", { "allowAny": true }],
      "@typescript-eslint/require-array-sort-compare": "error",
      "@typescript-eslint/restrict-plus-operands": "error",
      "semi": "off",
--- a/.gitattributes
+++ b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
--- a/.github/filters.yml
+++ b/.github/filters.yml
@@ -0,0 +1,4 @@
+error:
+  - not_existing_path/**/*
+any:
+  - "**/*"
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,9 +1,6 @@
-name: "build-test"
+name: "Build"
 on:
-  pull_request:
-    types:
-      - opened
-      - synchronize
+  push:
    branches:
      - master

@@ -16,21 +13,14 @@ jobs:
        npm install
        npm run all

-  test:
+  self-test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: ./
      id: filter
      with:
-        githubToken: ${{ github.token }}
-        filters: |
-          src:
-            - src/**/*
-          tests:
-            - __tests__/**/*
-          any:
-            - "**/*"
+        filters: '.github/filters.yml'
    - name: filter-test
-      if: steps.filter.outputs.any != 'true'
+      if: steps.filter.outputs.any != 'true' || steps.filter.outputs.error == 'true'
      run: exit 1
--- a/.github/workflows/pull-request-verification.yml
+++ b/.github/workflows/pull-request-verification.yml
@@ -0,0 +1,116 @@
+name: "Pull Request Verification"
+on:
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - run: |
+        npm install
+        npm run all
+
+  test-inline:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ./
+      id: filter
+      with:
+        filters: |
+          error:
+            - not_existing_path/**/*
+          any:
+            - "**/*"
+    - name: filter-test
+      if: steps.filter.outputs.any != 'true' || steps.filter.outputs.error == 'true'
+      run: exit 1
+
+  test-external:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ./
+      id: filter
+      with:
+        filters: '.github/filters.yml'
+    - name: filter-test
+      if: steps.filter.outputs.any != 'true' || steps.filter.outputs.error == 'true'
+      run: exit 1
+
+  test-without-token:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ./
+      id: filter
+      with:
+        token: ''
+        filters: '.github/filters.yml'
+    - name: filter-test
+      if: steps.filter.outputs.any != 'true' || steps.filter.outputs.error == 'true'
+      run: exit 1
+
+  test-wd-without-token:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        path: somewhere
+    - uses: ./somewhere
+      id: filter
+      with:
+        token: ''
+        working-directory: somewhere
+        filters: '.github/filters.yml'
+    - name: filter-test
+      if: steps.filter.outputs.any != 'true' || steps.filter.outputs.error == 'true'
+      run: exit 1
+
+  test-change-type:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: configure GIT user
+      run: git config user.email "john@nowhere.local" && git config user.name "John Doe"
+    - name: modify working tree
+      run: touch add.txt && rm README.md && echo "TEST" > LICENSE
+    - name: commit changes
+      run: git add -A && git commit -a -m 'testing this action'
+    - uses: ./
+      id: filter
+      with:
+        token: ''
+        list-files: shell
+        filters: |
+          added:
+            - added: "add.txt"
+          deleted:
+            - deleted: "README.md"
+          modified:
+            - modified: "LICENSE"
+          any:
+            - added|deleted|modified: "*"
+    - name: Print 'added_files'
+      run: echo ${{steps.filter.outputs.added_files}}
+    - name: Print 'modified_files'
+      run: echo ${{steps.filter.outputs.modified_files}}
+    - name: Print 'deleted_files'
+      run: echo ${{steps.filter.outputs.deleted_files}}
+    - name: filter-test
+      # only single quotes are supported in GH action literal
+      # single quote needs to be escaped with single quote
+      # '''add.txt''' resolves to string 'add.txt'
+      if: |
+        steps.filter.outputs.added != 'true'
+        || steps.filter.outputs.deleted != 'true'
+        || steps.filter.outputs.modified != 'true'
+        || steps.filter.outputs.any != 'true'
+        || steps.filter.outputs.added_files != '''add.txt'''
+        || steps.filter.outputs.modified_files != '''LICENSE'''
+        || steps.filter.outputs.deleted_files != '''README.md'''
+      run: exit 1
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -0,0 +1,52 @@
+# Changelog
+
+## v2.5.2
+- [Add support for multiple patterns when using file status](https://github.com/dorny/paths-filter/pull/48)
+- [Use picomatch directly instead of micromatch wrapper](https://github.com/dorny/paths-filter/pull/49)
+
+## v2.5.1
+- [Improved path matching with micromatch](https://github.com/dorny/paths-filter/pull/46)
+
+## v2.5.0
+- [Support workflows triggered by any event](https://github.com/dorny/paths-filter/pull/44)
+
+## v2.4.2
+- [Fixed compatibility with older (<2.23) versions of git](https://github.com/dorny/paths-filter/pull/42)
+
+## v2.4.0
+- [Support pushes of tags or when tag is used as base](https://github.com/dorny/paths-filter/pull/40)
+- [Use git log to detect changes from PRs merge commit if token is not available](https://github.com/dorny/paths-filter/pull/40)
+- [Support local execution with act](https://github.com/dorny/paths-filter/pull/40)
+- [Improved processing of repository initial push](https://github.com/dorny/paths-filter/pull/40)
+- [Improved processing of first push of new branch](https://github.com/dorny/paths-filter/pull/40)
+
+
+## v2.3.0
+- [Improved documentation](https://github.com/dorny/paths-filter/pull/37)
+- [Change detection using git "three dot" diff](https://github.com/dorny/paths-filter/pull/35)
+- [Export files matching filter](https://github.com/dorny/paths-filter/pull/32)
+- [Extend filter syntax with optional specification of file status: add, modified, deleted](https://github.com/dorny/paths-filter/pull/22)
+- [Add working-directory input](https://github.com/dorny/paths-filter/pull/21)
+
+## v2.2.1
+- [Add support for pull_request_target](https://github.com/dorny/paths-filter/pull/29)
+
+## v2.2.0
+- [Improve change detection for feature branches](https://github.com/dorny/paths-filter/pull/16)
+
+## v2.1.0
+- [Support reusable paths blocks with yaml anchors](https://github.com/dorny/paths-filter/pull/13)
+
+## v2.0.0
+- [Added support for workflows triggered by push events](https://github.com/dorny/paths-filter/pull/10)
+- Action and repository renamed to paths-filter - original name doesn't make sense anymore
+
+## v1.1.0
+- [Allows filters to be specified in own .yml file](https://github.com/dorny/paths-filter/pull/8)
+- [Adds alternative change detection using git fetch and git diff-index](https://github.com/dorny/paths-filter/pull/9)
+
+## v1.0.1
+Updated dependencies - fixes github security alert
+
+## v1.0.0
+First official release uploaded to marketplace.
--- a/2
+++ b/2
@@ -1,7 +1,7 @@

 The MIT License (MIT)

-Copyright (c) 2018 GitHub, Inc. and contributors
+Copyright (c) 2020 Michal Dorner and contributors

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- a/README.md
+++ b/README.md
@@ -1,74 +1,180 @@
-<p align="center">
-  <a href="https://github.com/dorny/pr-changed-files-filter/actions"><img alt="typescript-action status" src="https://github.com/dorny/pr-changed-files-filter/workflows/build-test/badge.svg"></a>
-</p>
+# Paths Changes Filter

-**CAUTION**: This action can be only used in a workflow triggered by `pull_request` event.
+This [Github Action](https://github.com/features/actions) enables conditional execution of workflow steps and jobs,
+based on the files modified by pull request, feature branch or in pushed commits.

-# Pull request changed files filter
-
-This [Github Action](https://github.com/features/actions) enables conditional execution of workflow job steps considering which files are modified by a pull request.
-
-It saves time and resources especially in monorepo setups, where you can run slow tasks (e.g. integration tests) only for changed components.
-Github workflows built-in
-[path filters](https://help.github.com/en/actions/referenceworkflow-syntax-for-github-actions#onpushpull_requestpaths)
+It saves time and resources especially in monorepo setups, where you can run slow tasks (e.g. integration tests or deployments) only for changed components.
+Github workflows built-in [path filters](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)
 doesn't allow this because they doesn't work on a level of individual jobs or steps.

-## Usage
-
-The action accepts filter rules in the YAML format.
-Each filter rule is a list of [glob expressions](https://github.com/isaacs/minimatch).
-Corresponding output variable will be created to indicate if there's a changed file matching any of the rule glob expressions.
-Output variables can be later used in the `if` clause to conditionally run specific steps.
-
-### Inputs
- **`githubToken`**: GitHub Access Token - use `${{ github.token }}`
- **`filters`**: YAML dictionary where keys specifies rule names and values are lists of file path patterns
-
-### Outputs
- For each rule it sets output variable named by the rule to text:
-   - `'true'` - if **any** of changed files matches any of rule patterns
-   - `'false'` - if **none** of changed files matches any of rule patterns
+**Real world usage examples:**
+- [sentry.io](https://sentry.io/) - [backend-test-py3.6.yml](https://github.com/getsentry/sentry/blob/ca0e43dc5602a9ab2e06d3f6397cc48fb5a78541/.github/workflows/backend-test-py3.6.yml#L32)
+- [GoogleChrome/web.dev](https://web.dev/) - [lint-and-test-workflow.yml](https://github.com/GoogleChrome/web.dev/blob/e1f0c28964e99ce6a996c1e3fd3ee1985a7a04f6/.github/workflows/lint-and-test-workflow.yml#L33)


-### Notes
- minimatch [dot](https://www.npmjs.com/package/minimatch#dot) option is set to true - therefore
-  globbing will match also paths where file or folder name starts with a dot.
+## Supported workflows:
+- **Pull requests:**
+  - Workflow triggered by **[pull_request](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request)**
+    or **[pull_request_target](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target)** event
+  - Changes are detected against the pull request base branch
+  - Uses Github REST API to fetch list of modified files
+- **Feature branches:**
+  - Workflow triggered by **[push](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#push)**
+  or any other **[event](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)**
+  - The `base` input parameter must not be the same as the branch that triggered the workflow
+  - Changes are detected against the merge-base with configured base branch or default branch
+  - Uses git commands to detect changes - repository must be already [checked out](https://github.com/actions/checkout)
+- **Master, Release or other long-lived branches:**
+  - Workflow triggered by **[push](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#push)** event
+  when `base` input parameter is same as the branch that triggered the workflow:
+    - Changes are detected against the most recent commit on the same branch before the push
+  - Workflow triggered by any other **[event](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)**
+  when `base` input parameter is commit SHA:
+    - Changes are detected against the provided `base` commit
+  - Workflow triggered by any other **[event](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)**
+  when `base` input parameter is same as the branch that triggered the workflow:
+    - Changes are detected from last commit
+  - Uses git commands to detect changes - repository must be already [checked out](https://github.com/actions/checkout)

-### Sample workflow
+## Example
 ```yaml
-...
-name: Build verification
+- uses: dorny/paths-filter@v2
+  id: changes
+  with:
+    filters: |
+      src:
+        - 'src/**'

-on:
-  pull_request:
-    types:
-      - opened
-      - edited
-      - synchronize
-    branches:
-      - master
+  # run only if some file in 'src' folder was changed
+  if: steps.changes.outputs.src == 'true'
+  run: ...
+```
+For more scenarios see [examples](#examples) section.
+
+## Notes:
+- Paths expressions are evaluated using [picomatch](https://github.com/micromatch/picomatch) library.
+  Documentation for path expression format can be found on project github page.
+- Micromatch [dot](https://github.com/micromatch/picomatch#options) option is set to true.
+  Globbing will match also paths where file or folder name starts with a dot.
+- It's recommended to quote your path expressions with `'` or `"`. Otherwise you will get an error if it starts with `*`.
+- Local execution with [act](https://github.com/nektos/act) works only with alternative runner image. Default runner doesn't have `git` binary.
+  - Use: `act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04`
+
+
+# What's New
+- Paths expressions are now evaluated using [picomatch](https://github.com/micromatch/picomatch) library
+- Support workflows triggered by any event
+- Fixed compatibility with older (<2.23) versions of git
+- Support for tag pushes and tags as a base reference
+- Fixes for various edge cases when event payload is incomplete
+  - Supports local execution with [act](https://github.com/nektos/act)
+- Fixed behavior of feature branch workflow:
+  - Detects only changes introduced by feature branch. Later modifications on base branch are ignored
+- Filter by type of file change:
+  - Optionally consider if file was added, modified or deleted
+
+For more information see [CHANGELOG](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
+
+# Usage
+
+```yaml
+- uses: dorny/paths-filter@v2
+  with:
+    # Defines filters applied to detected changed files.
+    # Each filter has a name and list of rules.
+    # Rule is a glob expression - paths of all changed
+    # files are matched against it.
+    # Rule can optionally specify if the file
+    # should be added, modified or deleted.
+    # For each filter there will be corresponding output variable to
+    # indicate if there's a changed file matching any of the rules.
+    # Optionally there can be a second output variable
+    # set to list of all files matching the filter.
+    # Filters can be provided inline as a string (containing valid YAML document)
+    # or as a relative path to separate file (e.g.: .github/filters.yaml).
+    # Multiline string is evaluated as embedded filter definition,
+    # single line string is evaluated as relative path to separate file.
+    # Filters syntax is documented by example - see examples section.
+    filters: ''
+
+    # Branch, tag or commit SHA against which the changes will be detected.
+    # If it references same branch it was pushed to,
+    # changes are detected against the most recent commit before the push.
+    # Otherwise it uses git merge-base to find best common ancestor between
+    # current branch (HEAD) and base.
+    # When merge-base is found, it's used for change detection - only changes
+    # introduced by current branch are considered.
+    # All files are considered as added if there is no common ancestor with
+    # base branch or no previous commit.
+    # This option is ignored if action is triggered by pull_request event.
+    # Default: repository default branch (e.g. master)
+    base: ''
+
+    # How many commits are initially fetched from base branch.
+    # If needed, each subsequent fetch doubles the
+    # previously requested number of commits until the merge-base
+    # is found or there are no more commits in the history.
+    # This option takes effect only when changes are detected
+    # using git against base branch (feature branch workflow).
+    # Default: 20
+    initial-fetch-depth: ''
+
+    # Enables listing of files matching the filter:
+    #   'none'  - Disables listing of matching files (default).
+    #   'json'  - Matching files paths are formatted as JSON array.
+    #   'shell' - Matching files paths are escaped and space-delimited.
+    #             Output is usable as command line argument list in linux shell.
+    # Default: none
+    list-files: ''
+
+    # Relative path under $GITHUB_WORKSPACE where the repository was checked out.
+    working-directory: ''
+
+    # Personal access token used to fetch list of changed files
+    # from Github REST API.
+    # It's used only if action is triggered by pull request event.
+    # Github token from workflow context is used as default value.
+    # If empty string is provided, action falls back to detect
+    # changes using git commands.
+    # Default: ${{ github.token }}
+    token: ''
+```
+
+## Outputs
+- For each filter it sets output variable named by the filter to the text:
+   - `'true'` - if **any** of changed files matches any of filter rules
+   - `'false'` - if **none** of changed files matches any of filter rules
+- If enabled, for each filter it sets output variable with name `${FILTER_NAME}_files`. It will contain list of all files matching the filter.
+
+# Examples
+
+## Conditional execution
+
+<details>
+  <summary>Execute <b>step</b> in a workflow job only if some file in a subfolder is changed</summary>
+
+```yaml
 jobs:
  tests:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
-    - uses: dorny/pr-changed-files-filter@v1
+    - uses: dorny/paths-filter@v2
      id: filter
      with:
-        githubToken: ${{ github.token }}
        filters: |
          backend:
-            - 'backend/**/*'
+            - 'backend/**'
          frontend:
-            - 'frontend/**/*'
+            - 'frontend/**'

    # run only if 'backend' files were changed
-    - name: backend unit tests
+    - name: backend tests
      if: steps.filter.outputs.backend == 'true'
      run: ...

    # run only if 'frontend' files were changed
-    - name: frontend unit tests
+    - name: frontend tests
      if: steps.filter.outputs.frontend == 'true'
      run: ...

@@ -77,25 +183,238 @@ jobs:
      if: steps.filter.outputs.backend == 'true' || steps.filter.outputs.frontend == 'true'
      run: ...
 ```
+</details>

-## How it works
+<details>
+  <summary>Execute <b>job</b> in a workflow only if some file in a subfolder is changed</summary>

-1. Required inputs are checked (`githubToken` & `filters`)
-2. Provided access token is used to fetch list of changed files.
-3. For each filter rule it checks if there is any matching file
-4. Output variables are set
+```yml
+jobs:
+  # JOB to run change detection
+  changes:
+    runs-on: ubuntu-latest
+    # Set job outputs to values from filter step
+    outputs:
+      backend: ${{ steps.filter.outputs.backend }}
+      frontend: ${{ steps.filter.outputs.frontend }}
+    steps:
+    # For pull requests it's not necessary to checkout the code
+    - uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        filters: |
+          backend:
+            - 'backend/**'
+          frontend:
+            - 'frontend/**'

-## Difference from related projects:
+  # JOB to build and test backend code
+  backend:
+    needs: changes
+    if: ${{ needs.changes.outputs.backend == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - ...

- [Has Changed Path](https://github.com/MarceloPrado/has-changed-path)
-  - detects changes from previous commit
-  - you have to configure `checkout` action to fetch some number of previous commits
-  - `git diff` is used for change detection
-  - outputs only single `true` / `false` value if any of provided paths contains changes
- [Changed Files Exporter](https://github.com/futuratrepadeira/changed-files)
-  - outputs lists with paths of created, updated and deleted files
-  - output is not directly usable in the `if` clause
- [Changed File Filter](https://github.com/tony84727/changed-file-filter)
-  - allows change detection between any refs or commits
-  - fetches whole history of your git repository
-  - might have negative performance impact on big repositories (github by default fetches only single commit)
+  # JOB to build and test frontend code
+  frontend:
+    needs: changes
+    if: ${{ needs.changes.outputs.frontend == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - ...
+```
+</details>
+
+## Change detection workflows
+
+<details>
+  <summary><b>Pull requests:</b> Detect changes against PR base branch</summary>
+
+```yaml
+on:
+  pull_request:
+    branches: # PRs to following branches will trigger the workflow
+      - master
+      - develop
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        filters: ... # Configure your filters
+```
+</details>
+
+<details>
+  <summary><b>Feature branch:</b> Detect changes against configured base branch</summary>
+
+```yaml
+on:
+  push:
+    branches: # Push to following branches will trigger the workflow
+      - feature/**
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        # This may save additional git fetch roundtrip if
+        # merge-base is found within latest 20 commits
+        fetch-depth: 20
+    - uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        base: develop # Change detection against merge-base with this branch
+        filters: ... # Configure your filters
+```
+</details>
+
+<details>
+  <summary><b>Long lived branches:</b> Detect changes against the most recent commit on the same branch before the push</summary>
+
+```yaml
+on:
+  push:
+    branches: # Push to following branches will trigger the workflow
+      - master
+      - develop
+      - release/**
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        # Use context to get branch where commits were pushed.
+        # If there is only one long lived branch (e.g. master),
+        # you can specify it directly.
+        # If it's not configured, the repository default branch is used.
+        base: ${{ github.ref }}
+        filters: ... # Configure your filters
+```
+</details>
+
+## Advanced options
+
+<details>
+  <summary>Define filter rules in own file</summary>
+
+```yaml
+- uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        # Path to file where filters are defined
+        filters: .github/filters.yaml
+```
+</details>
+
+<details>
+  <summary>Use YAML anchors to reuse path expression(s) inside another rule</summary>
+
+```yaml
+- uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        # &shared is YAML anchor,
+        # *shared references previously defined anchor
+        # src filter will match any path under common, config and src folders
+        filters: |
+          shared: &shared
+            - common/**
+            - config/**
+          src:
+            - *shared
+            - src/**
+```
+</details>
+
+<details>
+  <summary>Consider if file was added, modified or deleted</summary>
+
+```yaml
+- uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        # Changed file can be 'added', 'modified', or 'deleted'.
+        # By default the type of change is not considered.
+        # Optionally it's possible to specify it using nested
+        # dictionary, where type(s) of change composes the key.
+        # Multiple change types can be specified using `|` as delimiter.
+        filters: |
+          shared: &shared
+            - common/**
+            - config/**
+          addedOrModified:
+            - added|modified: '**'
+          allChanges:
+            - added|deleted|modified: '**'
+          addedOrModifiedAnchors:
+            - added|modified: *shared
+```
+</details>
+
+
+## Custom processing of changed files
+
+<details>
+  <summary>Passing list of modified files as command line args in Linux shell</summary>
+
+```yaml
+- uses: dorny/paths-filter@v2
+  id: filter
+  with:
+    # Enable listing of files matching each filter.
+    # Paths to files will be available in `${FILTER_NAME}_files` output variable.
+    # Paths will be escaped and space-delimited.
+    # Output is usable as command line argument list in linux shell
+    list-files: shell
+
+    # In this example changed files will be checked by linter.
+    # It doesn't make sense to lint deleted files.
+    # Therefore we specify we are only interested in added or modified files.
+    filters: |
+      markdown:
+        - added|modified: '*.md'
+- name: Lint Markdown
+  if: ${{ steps.filter.outputs.markdown == 'true' }}
+  run: npx textlint ${{ steps.filter.outputs.markdown_files }}
+```
+</details>
+
+<details>
+  <summary>Passing list of modified files as JSON array to another action</summary>
+
+```yaml
+- uses: dorny/paths-filter@v2
+  id: filter
+  with:
+    # Enable listing of files matching each filter.
+    # Paths to files will be available in `${FILTER_NAME}_files` output variable.
+    # Paths will be formatted as JSON array
+    list-files: json
+
+    # In this example all changed files are passed to following action to do
+    # some custom processing.
+    filters: |
+      changed:
+        - '**'
+- name: Lint Markdown
+  uses: johndoe/some-action@v1
+  with:
+    files: ${{ steps.filter.outputs.changed_files }}
+```
+</details>
+
+
+# License
+
+The scripts and documentation in this project are released under the [MIT License](https://github.com/dorny/paths-filter/blob/master/LICENSE)
--- a/tests/filter.test.ts
+++ b/tests/filter.test.ts
@@ -0,0 +1,188 @@
+import {Filter} from '../src/filter'
+import {File, ChangeStatus} from '../src/file'
+
+describe('yaml filter parsing tests', () => {
+  test('throws if yaml is not a dictionary', () => {
+    const yaml = 'not a dictionary'
+    const t = () => new Filter(yaml)
+    expect(t).toThrow(/^Invalid filter.*/)
+  })
+  test('throws if pattern is not a string', () => {
+    const yaml = `
+    src:
+      - src/**/*.js
+      - dict:
+          some: value
+    `
+    const t = () => new Filter(yaml)
+    expect(t).toThrow(/^Invalid filter.*/)
+  })
+})
+
+describe('matching tests', () => {
+  test('matches single inline rule', () => {
+    const yaml = `
+    src: "src/**/*.js"
+    `
+    let filter = new Filter(yaml)
+    const files = modified(['src/app/module/file.js'])
+    const match = filter.match(files)
+    expect(match.src).toEqual(files)
+  })
+  test('matches single rule in single group', () => {
+    const yaml = `
+    src:
+      - src/**/*.js
+    `
+    const filter = new Filter(yaml)
+    const files = modified(['src/app/module/file.js'])
+    const match = filter.match(files)
+    expect(match.src).toEqual(files)
+  })
+
+  test('no match when file is in different folder', () => {
+    const yaml = `
+    src:
+      - src/**/*.js
+    `
+    const filter = new Filter(yaml)
+    const match = filter.match(modified(['not_src/other_file.js']))
+    expect(match.src).toEqual([])
+  })
+
+  test('match only within second groups ', () => {
+    const yaml = `
+    src:
+      - src/**/*.js
+    test:
+      - test/**/*.js
+    `
+    const filter = new Filter(yaml)
+    const files = modified(['test/test.js'])
+    const match = filter.match(files)
+    expect(match.src).toEqual([])
+    expect(match.test).toEqual(files)
+  })
+
+  test('match only withing second rule of single group', () => {
+    const yaml = `
+    src:
+      - src/**/*.js
+      - test/**/*.js
+    `
+    const filter = new Filter(yaml)
+    const files = modified(['test/test.js'])
+    const match = filter.match(files)
+    expect(match.src).toEqual(files)
+  })
+
+  test('matches anything', () => {
+    const yaml = `
+    any:
+      - "**"
+    `
+    const filter = new Filter(yaml)
+    const files = modified(['test/test.js'])
+    const match = filter.match(files)
+    expect(match.any).toEqual(files)
+  })
+
+  test('globbing matches path where file or folder name starts with dot', () => {
+    const yaml = `
+    dot:
+      - "**/*.js"
+    `
+    const filter = new Filter(yaml)
+    const files = modified(['.test/.test.js'])
+    const match = filter.match(files)
+    expect(match.dot).toEqual(files)
+  })
+
+  test('matches all except tsx and less files (negate a group with or-ed parts)', () => {
+    const yaml = `
+    backend:
+      - '!(**/*.tsx|**/*.less)'
+    `
+    const filter = new Filter(yaml)
+    const tsxFiles = modified(['src/ui.tsx'])
+    const lessFiles = modified(['src/ui.less'])
+    const pyFiles = modified(['src/server.py'])
+
+    const tsxMatch = filter.match(tsxFiles)
+    const lessMatch = filter.match(lessFiles)
+    const pyMatch = filter.match(pyFiles)
+
+    expect(tsxMatch.backend).toEqual([])
+    expect(lessMatch.backend).toEqual([])
+    expect(pyMatch.backend).toEqual(pyFiles)
+  })
+
+  test('matches path based on rules included using YAML anchor', () => {
+    const yaml = `
+    shared: &shared
+      - common/**/*
+      - config/**/*
+    src:
+      - *shared
+      - src/**/*
+    `
+    const filter = new Filter(yaml)
+    const files = modified(['config/settings.yml'])
+    const match = filter.match(files)
+    expect(match.src).toEqual(files)
+  })
+})
+
+describe('matching specific change status', () => {
+  test('does not match modified file as added', () => {
+    const yaml = `
+    add:
+      - added: "**/*"
+    `
+    let filter = new Filter(yaml)
+    const match = filter.match(modified(['file.js']))
+    expect(match.add).toEqual([])
+  })
+
+  test('match added file as added', () => {
+    const yaml = `
+    add:
+      - added: "**/*"
+    `
+    let filter = new Filter(yaml)
+    const files = [{status: ChangeStatus.Added, filename: 'file.js'}]
+    const match = filter.match(files)
+    expect(match.add).toEqual(files)
+  })
+
+  test('matches when multiple statuses are configured', () => {
+    const yaml = `
+    addOrModify:
+      - added|modified: "**/*"
+    `
+    let filter = new Filter(yaml)
+    const files = [{status: ChangeStatus.Modified, filename: 'file.js'}]
+    const match = filter.match(files)
+    expect(match.addOrModify).toEqual(files)
+  })
+
+  test('matches when using an anchor', () => {
+    const yaml = `
+    shared: &shared
+      - common/**/*
+      - config/**/*
+    src:
+      - modified: *shared
+    `
+    let filter = new Filter(yaml)
+    const files = modified(['config/file.js', 'common/anotherFile.js'])
+    const match = filter.match(files)
+    expect(match.src).toEqual(files)
+  })
+})
+
+function modified(paths: string[]): File[] {
+  return paths.map(filename => {
+    return {filename, status: ChangeStatus.Modified}
+  })
+}
--- a/tests/git.test.ts
+++ b/tests/git.test.ts
@@ -0,0 +1,35 @@
+import * as git from '../src/git'
+import {ChangeStatus} from '../src/file'
+
+describe('parsing output of the git diff command', () => {
+  test('parseGitDiffOutput returns files with correct change status', async () => {
+    const files = git.parseGitDiffOutput(
+      'A\u0000LICENSE\u0000' + 'M\u0000src/index.ts\u0000' + 'D\u0000src/main.ts\u0000'
+    )
+    expect(files.length).toBe(3)
+    expect(files[0].filename).toBe('LICENSE')
+    expect(files[0].status).toBe(ChangeStatus.Added)
+    expect(files[1].filename).toBe('src/index.ts')
+    expect(files[1].status).toBe(ChangeStatus.Modified)
+    expect(files[2].filename).toBe('src/main.ts')
+    expect(files[2].status).toBe(ChangeStatus.Deleted)
+  })
+})
+
+describe('git utility function tests (those not invoking git)', () => {
+  test('Trims "refs/" and "heads/" from ref', () => {
+    expect(git.getShortName('refs/heads/master')).toBe('master')
+    expect(git.getShortName('heads/master')).toBe('heads/master')
+    expect(git.getShortName('master')).toBe('master')
+
+    expect(git.getShortName('refs/tags/v1')).toBe('v1')
+    expect(git.getShortName('tags/v1')).toBe('tags/v1')
+    expect(git.getShortName('v1')).toBe('v1')
+  })
+
+  test('isGitSha(ref) returns true only for 40 characters of a-z and 0-9', () => {
+    expect(git.isGitSha('8b399ed1681b9efd6b1e048ca1c5cba47edf3855')).toBeTruthy()
+    expect(git.isGitSha('This_is_very_long_name_for_a_branch_1111')).toBeFalsy()
+    expect(git.isGitSha('master')).toBeFalsy()
+  })
+})
--- a/tests/main.test.ts
+++ b/tests/main.test.ts
@@ -1,93 +0,0 @@
-import Filter from '../src/filter'
-
-describe('yaml filter parsing tests', () => {
-  test('throws if yaml is not a dictionary', () => {
-    const yaml = 'not a dictionary'
-    const t = () => new Filter(yaml)
-    expect(t).toThrow(/^Invalid filter.*/)
-  })
-  test('throws on invalid yaml', () => {
-    const yaml = `
-    src:
-      src/**/*.js
-    `
-    const t = () => new Filter(yaml)
-    expect(t).toThrow(/^Invalid filter.*/)
-  })
-  test('throws if pattern is not a string', () => {
-    const yaml = `
-    src:
-      - src/**/*.js
-      - dict:
-          some: value
-    `
-    const t = () => new Filter(yaml)
-    expect(t).toThrow(/^Invalid filter.*/)
-  })
-})
-
-describe('matching tests', () => {
-  test('matches single rule in single group', () => {
-    const yaml = `
-    src:
-      - src/**/*.js
-    `
-    const filter = new Filter(yaml)
-    const match = filter.match(['src/app/module/file.js'])
-    expect(match.src).toBeTruthy()
-  })
-
-  test('no match when file is in different folder', () => {
-    const yaml = `
-    src:
-      - src/**/*.js
-    `
-    const filter = new Filter(yaml)
-    const match = filter.match(['not_src/other_file.js'])
-    expect(match.src).toBeFalsy()
-  })
-
-  test('match only within second groups ', () => {
-    const yaml = `
-    src:
-      - src/**/*.js
-    test:
-      - test/**/*.js
-    `
-    const filter = new Filter(yaml)
-    const match = filter.match(['test/test.js'])
-    expect(match.src).toBeFalsy()
-    expect(match.test).toBeTruthy()
-  })
-
-  test('match only withing second rule of single group', () => {
-    const yaml = `
-    src:
-      - src/**/*.js
-      - test/**/*.js
-    `
-    const filter = new Filter(yaml)
-    const match = filter.match(['test/test.js'])
-    expect(match.src).toBeTruthy()
-  })
-
-  test('matches anything', () => {
-    const yaml = `
-    any:
-      - "**/*"
-    `
-    const filter = new Filter(yaml)
-    const match = filter.match(['test/test.js'])
-    expect(match.any).toBeTruthy()
-  })
-
-  test('globbing matches path where file or folder name starts with dot', () => {
-    const yaml = `
-    dot:
-      - "**/*.js"
-    `
-    const filter = new Filter(yaml)
-    const match = filter.match(['.test/.test.js'])
-    expect(match.dot).toBeTruthy()
-  })
-})
--- a/tests/shell-escape.test.ts
+++ b/tests/shell-escape.test.ts
@@ -0,0 +1,16 @@
+import shellEscape from '../src/shell-escape'
+
+test('simple path escaped', () => {
+  expect(shellEscape('file')).toBe("'file'")
+})
+
+test('path with space is wrapped with single quotes', () => {
+  expect(shellEscape('file with space')).toBe("'file with space'")
+})
+
+test('path with quote is divided into quoted segments and escaped quote', () => {
+  expect(shellEscape("file'with quote")).toBe("'file'\\''with quote'")
+})
+test('path with leading quote does not have double quotes at beginning', () => {
+  expect(shellEscape("'file-leading-quote")).toBe("\\''file-leading-quote'")
+})
--- a/action.yml
+++ b/action.yml
@@ -1,16 +1,42 @@
-name: 'Pull request changed files filter'
-description: 'Enables conditional execution of workflow job steps considering which files are modified by a pull request.'
+name: 'Paths Changes Filter'
+description: 'Execute your workflow steps only if relevant files are modified.'
 author: 'Michal Dorner <dorner.michal@gmail.com>'
 inputs:
-  githubToken:
+  token:
    description: 'GitHub Access Token'
-    required: true
+    required: false
+    default: ${{ github.token }}
+  working-directory:
+    description: 'Relative path under $GITHUB_WORKSPACE where the repository was checked out.'
+    required: false
+  base:
+    description: |
+      Git reference (e.g. branch name) against which the changes will be detected. Defaults to repository default branch (e.g. master).
+      If it references same branch it was pushed to, changes are detected against the most recent commit before the push.
+      This option is ignored if action is triggered by pull_request event.
+    required: false
  filters:
-    description: 'YAML dictionary where keys specifies rule names and values are lists of (globbing) file path patterns'
+    description: 'Path to the configuration file or YAML string with filters definition'
    required: true
+  list-files:
+    description: |
+      Enables listing of files matching the filter:
+        'none'  - Disables listing of matching files (default).
+        'json'  - Matching files paths are serialized as JSON array.
+        'shell' - Matching files paths are escaped and space-delimited. Output is usable as command line argument list in linux shell.
+    required: true
+    default: none
+  initial-fetch-depth:
+    description: |
+      How many commits are initially fetched from base branch.
+      If needed, each subsequent fetch doubles the previously requested number of commits
+      until the merge-base is found or there are no more commits in the history.
+      This option takes effect only when changes are detected using git against different base branch.
+    required: false
+    default: '10'
 runs:
  using: 'node12'
  main: 'dist/index.js'
 branding:
  color: blue
-  icon: filter
+  icon: filter
--- a/dist/index.js
+++ b/dist/index.js
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "pr-changed-files-filter",
+  "name": "paths-filter",
  "version": "1.0.0",
  "private": true,
-  "description": "Enables conditional execution of workflow job steps considering which files are modified by a pull request.",
+  "description": "Execute your workflow steps only if relevant files are modified.",
  "main": "lib/main.js",
  "scripts": {
    "build": "tsc",
@@ -25,27 +25,29 @@
  "author": "YourNameOrOrganization",
  "license": "MIT",
  "dependencies": {
-    "@actions/core": "^1.2.0",
+    "@actions/core": "^1.2.4",
+    "@actions/exec": "^1.0.4",
    "@actions/github": "^2.2.0",
-    "@octokit/webhooks": "^7.6.1",
-    "minimatch": "^3.0.4"
+    "@octokit/webhooks": "^7.6.2",
+    "picomatch": "^2.2.2"
  },
  "devDependencies": {
-    "@types/jest": "^24.0.23",
+    "@types/jest": "^25.2.3",
    "@types/js-yaml": "^3.12.4",
    "@types/minimatch": "^3.0.3",
-    "@types/node": "^12.7.12",
-    "@typescript-eslint/parser": "^2.8.0",
-    "@zeit/ncc": "^0.22.2",
-    "eslint": "^5.16.0",
+    "@types/node": "^14.0.5",
+    "@types/picomatch": "^2.2.1",
+    "@typescript-eslint/parser": "^3.3.0",
+    "@zeit/ncc": "^0.22.3",
+    "eslint": "^7.3.0",
    "eslint-plugin-github": "^2.0.0",
    "eslint-plugin-jest": "^22.21.0",
-    "jest": "^24.9.0",
-    "jest-circus": "^24.9.0",
-    "js-yaml": "^3.13.1",
-    "prettier": "^1.19.1",
-    "ts-jest": "^24.2.0",
-    "typescript": "^3.6.4"
+    "jest": "^26.0.1",
+    "jest-circus": "^26.0.1",
+    "js-yaml": "^3.14.0",
+    "prettier": "^2.0.5",
+    "ts-jest": "^26.0.0",
+    "typescript": "^3.9.3"
  },
  "jest": {
    "testEnvironment": "node"
--- a/src/exec.ts
+++ b/src/exec.ts
@@ -0,0 +1,21 @@
+import {exec as execImpl, ExecOptions} from '@actions/exec'
+
+// Wraps original exec() function
+// Returns exit code and whole stdout/stderr
+export default async function exec(commandLine: string, args?: string[], options?: ExecOptions): Promise<ExecResult> {
+  options = options || {}
+  let stdout = ''
+  let stderr = ''
+  options.listeners = {
+    stdout: (data: Buffer) => (stdout += data.toString()),
+    stderr: (data: Buffer) => (stderr += data.toString())
+  }
+  const code = await execImpl(commandLine, args, options)
+  return {code, stdout, stderr}
+}
+
+export interface ExecResult {
+  code: number
+  stdout: string
+  stderr: string
+}
--- a/src/file.ts
+++ b/src/file.ts
@@ -0,0 +1,13 @@
+export interface File {
+  filename: string
+  status: ChangeStatus
+}
+
+export enum ChangeStatus {
+  Added = 'added',
+  Copied = 'copied',
+  Deleted = 'deleted',
+  Modified = 'modified',
+  Renamed = 'renamed',
+  Unmerged = 'unmerged'
+}
--- a/src/filter.ts
+++ b/src/filter.ts
@@ -1,42 +1,109 @@
 import * as jsyaml from 'js-yaml'
-import * as minimatch from 'minimatch'
+import picomatch from 'picomatch'
+import {File, ChangeStatus} from './file'

-export default class Filter {
-  rules: {[key: string]: minimatch.IMinimatch[]} = {}
+// Type definition of object we expect to load from YAML
+interface FilterYaml {
+  [name: string]: FilterItemYaml
+}
+type FilterItemYaml =
+  | string // Filename pattern, e.g. "path/to/*.js"
+  | {[changeTypes: string]: string | string[]} // Change status and filename, e.g. added|modified: "path/to/*.js"
+  | FilterItemYaml[] // Supports referencing another rule via YAML anchor

-  constructor(yaml: string) {
-    const doc = jsyaml.safeLoad(yaml)
-    if (typeof doc !== 'object') {
-      this.throwInvalidFormatError()
-    }
+// Minimatch options used in all matchers
+const MatchOptions = {
+  dot: true
+}

-    const opts: minimatch.IOptions = {
-      dot: true
-    }
+// Internal representation of one item in named filter rule
+// Created as simplified form of data in FilterItemYaml
+interface FilterRuleItem {
+  status?: ChangeStatus[] // Required change status of the matched files
+  isMatch: (str: string) => boolean // Matches the filename
+}

-    for (const name of Object.keys(doc)) {
-      const patterns = doc[name] as string[]
-      if (!Array.isArray(patterns)) {
-        this.throwInvalidFormatError()
-      }
-      if (!patterns.every(x => typeof x === 'string')) {
-        this.throwInvalidFormatError()
-      }
-      this.rules[name] = patterns.map(x => new minimatch.Minimatch(x, opts))
+export interface FilterResults {
+  [key: string]: File[]
+}
+
+export class Filter {
+  rules: {[key: string]: FilterRuleItem[]} = {}
+
+  // Creates instance of Filter and load rules from YAML if it's provided
+  constructor(yaml?: string) {
+    if (yaml) {
+      this.load(yaml)
    }
  }

-  // Returns dictionary with match result per rules group
-  match(paths: string[]): {[key: string]: boolean} {
-    const result: {[key: string]: boolean} = {}
+  // Load rules from YAML string
+  load(yaml: string): void {
+    if (!yaml) {
+      return
+    }
+
+    const doc = jsyaml.safeLoad(yaml) as FilterYaml
+    if (typeof doc !== 'object') {
+      this.throwInvalidFormatError('Root element is not an object')
+    }
+
+    for (const [key, item] of Object.entries(doc)) {
+      this.rules[key] = this.parseFilterItemYaml(item)
+    }
+  }
+
+  match(files: File[]): FilterResults {
+    const result: FilterResults = {}
    for (const [key, patterns] of Object.entries(this.rules)) {
-      const match = paths.some(fileName => patterns.some(rule => rule.match(fileName)))
-      result[key] = match
+      result[key] = files.filter(file => this.isMatch(file, patterns))
    }
    return result
  }

-  private throwInvalidFormatError(): never {
-    throw new Error('Invalid filter YAML format: Expected dictionary of string arrays')
+  private isMatch(file: File, patterns: FilterRuleItem[]): boolean {
+    return patterns.some(
+      rule => (rule.status === undefined || rule.status.includes(file.status)) && rule.isMatch(file.filename)
+    )
+  }
+
+  private parseFilterItemYaml(item: FilterItemYaml): FilterRuleItem[] {
+    if (Array.isArray(item)) {
+      return flat(item.map(i => this.parseFilterItemYaml(i)))
+    }
+
+    if (typeof item === 'string') {
+      return [{status: undefined, isMatch: picomatch(item, MatchOptions)}]
+    }
+
+    if (typeof item === 'object') {
+      return Object.entries(item).map(([key, pattern]) => {
+        if (typeof key !== 'string' || (typeof pattern !== 'string' && !Array.isArray(pattern))) {
+          this.throwInvalidFormatError(
+            `Expected [key:string]= pattern:string | string[], but [${key}:${typeof key}]= ${pattern}:${typeof pattern} found`
+          )
+        }
+        return {
+          status: key
+            .split('|')
+            .map(x => x.trim())
+            .filter(x => x.length > 0)
+            .map(x => x.toLowerCase()) as ChangeStatus[],
+          isMatch: picomatch(pattern, MatchOptions)
+        }
+      })
+    }
+
+    this.throwInvalidFormatError(`Unexpected element type '${typeof item}'`)
+  }
+
+  private throwInvalidFormatError(message: string): never {
+    throw new Error(`Invalid filter YAML format: ${message}.`)
  }
 }
+
+// Creates a new array with all sub-array elements concatenated
+// In future could be replaced by Array.prototype.flat (supported on Node.js 11+)
+function flat<T>(arr: T[][]): T[] {
+  return arr.reduce((acc, val) => acc.concat(val), [])
+}
--- a/src/git.ts
+++ b/src/git.ts
@@ -0,0 +1,189 @@
+import exec from './exec'
+import * as core from '@actions/core'
+import {File, ChangeStatus} from './file'
+
+export const NULL_SHA = '0000000000000000000000000000000000000000'
+
+export async function getChangesInLastCommit(): Promise<File[]> {
+  core.startGroup(`Change detection in last commit`)
+  let output = ''
+  try {
+    output = (await exec('git', ['log', '--format=', '--no-renames', '--name-status', '-z', '-n', '1'])).stdout
+  } finally {
+    fixStdOutNullTermination()
+    core.endGroup()
+  }
+
+  return parseGitDiffOutput(output)
+}
+
+export async function getChanges(ref: string): Promise<File[]> {
+  if (!(await hasCommit(ref))) {
+    // Fetch single commit
+    core.startGroup(`Fetching ${ref} from origin`)
+    await exec('git', ['fetch', '--depth=1', '--no-tags', 'origin', ref])
+    core.endGroup()
+  }
+
+  // Get differences between ref and HEAD
+  core.startGroup(`Change detection ${ref}..HEAD`)
+  let output = ''
+  try {
+    // Two dots '..' change detection - directly compares two versions
+    output = (await exec('git', ['diff', '--no-renames', '--name-status', '-z', `${ref}..HEAD`])).stdout
+  } finally {
+    fixStdOutNullTermination()
+    core.endGroup()
+  }
+
+  return parseGitDiffOutput(output)
+}
+
+export async function getChangesSinceMergeBase(ref: string, initialFetchDepth: number): Promise<File[]> {
+  if (!(await hasCommit(ref))) {
+    // Fetch and add base branch
+    core.startGroup(`Fetching ${ref}`)
+    try {
+      await exec('git', ['fetch', `--depth=${initialFetchDepth}`, '--no-tags', 'origin', `${ref}:${ref}`])
+    } finally {
+      core.endGroup()
+    }
+  }
+
+  async function hasMergeBase(): Promise<boolean> {
+    return (await exec('git', ['merge-base', ref, 'HEAD'], {ignoreReturnCode: true})).code === 0
+  }
+
+  async function countCommits(): Promise<number> {
+    return (await getNumberOfCommits('HEAD')) + (await getNumberOfCommits(ref))
+  }
+
+  core.startGroup(`Searching for merge-base with ${ref}`)
+  // Fetch more commits until merge-base is found
+  if (!(await hasMergeBase())) {
+    let deepen = initialFetchDepth
+    let lastCommitsCount = await countCommits()
+    do {
+      await exec('git', ['fetch', `--deepen=${deepen}`, '--no-tags'])
+      const count = await countCommits()
+      if (count <= lastCommitsCount) {
+        core.info('No merge base found - all files will be listed as added')
+        core.endGroup()
+        return await listAllFilesAsAdded()
+      }
+      lastCommitsCount = count
+      deepen = Math.min(deepen * 2, Number.MAX_SAFE_INTEGER)
+    } while (!(await hasMergeBase()))
+  }
+  core.endGroup()
+
+  // Get changes introduced on HEAD compared to ref
+  core.startGroup(`Change detection ${ref}...HEAD`)
+  let output = ''
+  try {
+    // Three dots '...' change detection - finds merge-base and compares against it
+    output = (await exec('git', ['diff', '--no-renames', '--name-status', '-z', `${ref}...HEAD`])).stdout
+  } finally {
+    fixStdOutNullTermination()
+    core.endGroup()
+  }
+
+  return parseGitDiffOutput(output)
+}
+
+export function parseGitDiffOutput(output: string): File[] {
+  const tokens = output.split('\u0000').filter(s => s.length > 0)
+  const files: File[] = []
+  for (let i = 0; i + 1 < tokens.length; i += 2) {
+    files.push({
+      status: statusMap[tokens[i]],
+      filename: tokens[i + 1]
+    })
+  }
+  return files
+}
+
+export async function listAllFilesAsAdded(): Promise<File[]> {
+  core.startGroup('Listing all files tracked by git')
+  let output = ''
+  try {
+    output = (await exec('git', ['ls-files', '-z'])).stdout
+  } finally {
+    fixStdOutNullTermination()
+    core.endGroup()
+  }
+
+  return output
+    .split('\u0000')
+    .filter(s => s.length > 0)
+    .map(path => ({
+      status: ChangeStatus.Added,
+      filename: path
+    }))
+}
+
+export async function getCurrentRef(): Promise<string> {
+  core.startGroup(`Determining current ref`)
+  try {
+    const branch = (await exec('git', ['branch', '--show-current'])).stdout.trim()
+    if (branch) {
+      return branch
+    }
+
+    const describe = await exec('git', ['describe', '--tags', '--exact-match'], {ignoreReturnCode: true})
+    if (describe.code === 0) {
+      return describe.stdout.trim()
+    }
+
+    return (await exec('git', ['rev-parse', 'HEAD'])).stdout.trim()
+  } finally {
+    core.endGroup()
+  }
+}
+
+export function getShortName(ref: string): string {
+  if (!ref) return ''
+
+  const heads = 'refs/heads/'
+  const tags = 'refs/tags/'
+
+  if (ref.startsWith(heads)) return ref.slice(heads.length)
+  if (ref.startsWith(tags)) return ref.slice(tags.length)
+
+  return ref
+}
+
+export function isGitSha(ref: string): boolean {
+  return /^[a-z0-9]{40}$/.test(ref)
+}
+
+async function hasCommit(ref: string): Promise<boolean> {
+  core.startGroup(`Checking if commit for ${ref} is locally available`)
+  try {
+    return (await exec('git', ['cat-file', '-e', `${ref}^{commit}`], {ignoreReturnCode: true})).code === 0
+  } finally {
+    core.endGroup()
+  }
+}
+
+async function getNumberOfCommits(ref: string): Promise<number> {
+  const output = (await exec('git', ['rev-list', `--count`, ref])).stdout
+  const count = parseInt(output)
+  return isNaN(count) ? 0 : count
+}
+
+function fixStdOutNullTermination(): void {
+  // Previous command uses NULL as delimiters and output is printed to stdout.
+  // We have to make sure next thing written to stdout will start on new line.
+  // Otherwise things like ::set-output wouldn't work.
+  core.info('')
+}
+
+const statusMap: {[char: string]: ChangeStatus} = {
+  A: ChangeStatus.Added,
+  C: ChangeStatus.Copied,
+  D: ChangeStatus.Deleted,
+  M: ChangeStatus.Modified,
+  R: ChangeStatus.Renamed,
+  U: ChangeStatus.Unmerged
+}
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,40 +1,132 @@
+import * as fs from 'fs'
 import * as core from '@actions/core'
 import * as github from '@actions/github'
 import {Webhooks} from '@octokit/webhooks'

-import Filter from './filter'
+import {Filter, FilterResults} from './filter'
+import {File, ChangeStatus} from './file'
+import * as git from './git'
+import shellEscape from './shell-escape'
+
+type ExportFormat = 'none' | 'json' | 'shell'

 async function run(): Promise<void> {
  try {
-    const token = core.getInput('githubToken', {required: true})
-    const filterYaml = core.getInput('filters', {required: true})
-    const client = new github.GitHub(token)
+    const workingDirectory = core.getInput('working-directory', {required: false})
+    if (workingDirectory) {
+      process.chdir(workingDirectory)
+    }

-    if (github.context.eventName !== 'pull_request') {
-      core.setFailed('This action can be triggered only by pull_request event')
+    const token = core.getInput('token', {required: false})
+    const base = core.getInput('base', {required: false})
+    const filtersInput = core.getInput('filters', {required: true})
+    const filtersYaml = isPathInput(filtersInput) ? getConfigFileContent(filtersInput) : filtersInput
+    const listFiles = core.getInput('list-files', {required: false}).toLowerCase() || 'none'
+    const initialFetchDepth = parseInt(core.getInput('initial-fetch-depth', {required: false})) || 10
+
+    if (!isExportFormat(listFiles)) {
+      core.setFailed(`Input parameter 'list-files' is set to invalid value '${listFiles}'`)
      return
    }

-    const pr = github.context.payload.pull_request as Webhooks.WebhookPayloadPullRequestPullRequest
-    const filter = new Filter(filterYaml)
-    const files = await getChangedFiles(client, pr)
-
-    const result = filter.match(files)
-    for (const key in result) {
-      core.setOutput(key, String(result[key]))
-    }
+    const filter = new Filter(filtersYaml)
+    const files = await getChangedFiles(token, base, initialFetchDepth)
+    const results = filter.match(files)
+    exportResults(results, listFiles)
  } catch (error) {
    core.setFailed(error.message)
  }
 }

+function isPathInput(text: string): boolean {
+  return !text.includes('\n')
+}
+
+function getConfigFileContent(configPath: string): string {
+  if (!fs.existsSync(configPath)) {
+    throw new Error(`Configuration file '${configPath}' not found`)
+  }
+
+  if (!fs.lstatSync(configPath).isFile()) {
+    throw new Error(`'${configPath}' is not a file.`)
+  }
+
+  return fs.readFileSync(configPath, {encoding: 'utf8'})
+}
+
+async function getChangedFiles(token: string, base: string, initialFetchDepth: number): Promise<File[]> {
+  if (github.context.eventName === 'pull_request' || github.context.eventName === 'pull_request_target') {
+    const pr = github.context.payload.pull_request as Webhooks.WebhookPayloadPullRequestPullRequest
+    if (token) {
+      return await getChangedFilesFromApi(token, pr)
+    }
+    core.info('Github token is not available - changes will be detected from PRs merge commit')
+    return await git.getChangesInLastCommit()
+  } else {
+    return getChangedFilesFromGit(base, initialFetchDepth)
+  }
+}
+
+async function getChangedFilesFromGit(base: string, initialFetchDepth: number): Promise<File[]> {
+  const defaultRef = github.context.payload.repository?.default_branch
+
+  const beforeSha =
+    github.context.eventName === 'push' ? (github.context.payload as Webhooks.WebhookPayloadPush).before : null
+
+  const pushRef =
+    git.getShortName(github.context.ref) ||
+    (core.warning(`'ref' field is missing in PUSH event payload - using current branch, tag or commit SHA`),
+    await git.getCurrentRef())
+
+  const baseRef = git.getShortName(base) || defaultRef
+  if (!baseRef) {
+    throw new Error(
+      "This action requires 'base' input to be configured or 'repository.default_branch' to be set in the event payload"
+    )
+  }
+
+  const isBaseRefSha = git.isGitSha(baseRef)
+  const isBaseSameAsPush = baseRef === pushRef
+
+  // If base is commit SHA will do comparison against the referenced commit
+  // Or If base references same branch it was pushed to, we will do comparison against the previously pushed commit
+  if (isBaseRefSha || isBaseSameAsPush) {
+    if (!isBaseRefSha && !beforeSha) {
+      core.warning(`'before' field is missing in PUSH event payload - changes will be detected from last commit`)
+      return await git.getChangesInLastCommit()
+    }
+
+    const baseSha = isBaseRefSha ? baseRef : beforeSha
+    // If there is no previously pushed commit,
+    // we will do comparison against the default branch or return all as added
+    if (baseSha === git.NULL_SHA) {
+      if (defaultRef && baseRef !== defaultRef) {
+        core.info(`First push of a branch detected - changes will be detected against the default branch ${defaultRef}`)
+        return await git.getChangesSinceMergeBase(defaultRef, initialFetchDepth)
+      } else {
+        core.info('Initial push detected - all files will be listed as added')
+        return await git.listAllFilesAsAdded()
+      }
+    }
+
+    core.info(`Changes will be detected against commit (${baseSha})`)
+    return await git.getChanges(baseSha)
+  }
+
+  // Changes introduced by current branch against the base branch
+  core.info(`Changes will be detected against the branch ${baseRef}`)
+  return await git.getChangesSinceMergeBase(baseRef, initialFetchDepth)
+}
+
 // Uses github REST api to get list of files changed in PR
-async function getChangedFiles(
-  client: github.GitHub,
+async function getChangedFilesFromApi(
+  token: string,
  pullRequest: Webhooks.WebhookPayloadPullRequestPullRequest
-): Promise<string[]> {
+): Promise<File[]> {
+  core.info(`Fetching list of changed files for PR#${pullRequest.number} from Github API`)
+  const client = new github.GitHub(token)
  const pageSize = 100
-  const files: string[] = []
+  const files: File[] = []
  for (let page = 0; page * pageSize < pullRequest.changed_files; page++) {
    const response = await client.pulls.listFiles({
      owner: github.context.repo.owner,
@@ -44,11 +136,68 @@ async function getChangedFiles(
      per_page: pageSize
    })
    for (const row of response.data) {
-      files.push(row.filename)
+      // There's no obvious use-case for detection of renames
+      // Therefore we treat it as if rename detection in git diff was turned off.
+      // Rename is replaced by delete of original filename and add of new filename
+      if (row.status === ChangeStatus.Renamed) {
+        files.push({
+          filename: row.filename,
+          status: ChangeStatus.Added
+        })
+        files.push({
+          // 'previous_filename' for some unknown reason isn't in the type definition or documentation
+          filename: (<any>row).previous_filename as string,
+          status: ChangeStatus.Deleted
+        })
+      } else {
+        files.push({
+          filename: row.filename,
+          status: row.status as ChangeStatus
+        })
+      }
    }
  }

  return files
 }

+function exportResults(results: FilterResults, format: ExportFormat): void {
+  core.info('Results:')
+  for (const [key, files] of Object.entries(results)) {
+    const value = files.length > 0
+    core.startGroup(`Filter ${key} = ${value}`)
+    if (files.length > 0) {
+      core.info('Matching files:')
+      for (const file of files) {
+        core.info(`${file.filename} [${file.status}]`)
+      }
+    } else {
+      core.info('Matching files: none')
+    }
+
+    core.setOutput(key, value)
+    if (format !== 'none') {
+      const filesValue = serializeExport(files, format)
+      core.setOutput(`${key}_files`, filesValue)
+    }
+  }
+  core.endGroup()
+}
+
+function serializeExport(files: File[], format: ExportFormat): string {
+  const fileNames = files.map(file => file.filename)
+  switch (format) {
+    case 'json':
+      return JSON.stringify(fileNames)
+    case 'shell':
+      return fileNames.map(shellEscape).join(' ')
+    default:
+      return ''
+  }
+}
+
+function isExportFormat(value: string): value is ExportFormat {
+  return value === 'none' || value === 'shell' || value === 'json'
+}
+
 run()
--- a/src/shell-escape.ts
+++ b/src/shell-escape.ts
@@ -0,0 +1,7 @@
+// Credits to https://github.com/xxorax/node-shell-escape
+
+export default function shellEscape(value: string): string {
+  return `'${value.replace(/'/g, "'\\''")}'`
+    .replace(/^(?:'')+/g, '') // unduplicate single-quote at the beginning
+    .replace(/\\'''/g, "\\'") // remove non-escaped single-quote if there are enclosed between 2 escaped
+}
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -1,6 +1,6 @@
 {
  "compilerOptions": {
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "target": "es2019",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
    "outDir": "./lib",                        /* Redirect output structure to the directory. */
    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
Author	SHA1	Message	Date
Michal Dorner	b4eabb6049	Use picomatch + impl followups from #48	2020-11-09 00:45:53 +01:00
Michal Dorner	550eb4925d	Merge pull request #48 from getsentry/master feat: Add support for multiple patterns when using file status	2020-11-09 00:26:00 +01:00
Billy Vong	5282566eab	feat: Add support for multiple patterns when using file status This adds support for using multiple patterns when checking for file status (added, modified, deleted) and as a result also allows you to use YAML anchors.	2020-11-06 17:41:51 -08:00
Billy Vong	804ec66d7a	Fix typo in README example (#47 ) The example was missing `outputs`	2020-11-03 09:23:07 +01:00
Michal Dorner	b37d4e9e86	Use micromatch instead of minimatch (#46 ) * Use micromatch instead of minimatch micromatch claims to support full Bash 4.3 spec and it actually passes all the tests. For example this fixes processing of '!(*/.tsx\|*/.less)' pattern - needed by #45 * Update CHANGELOG.md	2020-10-23 12:33:44 +02:00
Michal Dorner	7b5334ddb5	Add links to some real world usage examples	2020-10-17 22:38:15 +02:00
Michal Dorner	75cbfb4be9	Support workflows triggered by any event (#44 ) * Allow change detection on all event types * mention commit SHA in docs for base parameter * improve logging * update CHANGELOG.md	2020-10-16 12:28:12 +02:00
Michal Dorner	9bd03c0d68	Update CHANGELOG.md	2020-10-06 13:40:13 +02:00
Michal Dorner	9553dabbd8	Remove usage of --no-auto-gc option (#42 ) * Remove usage of --no-auto-gc option This option is not supported in git versions < 2.23. Older git versions might be used in self-hosted runners. * Update CHANGELOG	2020-10-06 13:38:18 +02:00
Michal Dorner	8b399ed168	Add minimal example to the top part of README	2020-10-01 10:55:29 +02:00
Michal Dorner	ff5bb057bf	v2.4.0 - support local execution with act + allow tags (#40 ) * Avoid code repetition with exec() and output listeners * Improve behavior for new branches and when it's running in ACT * Detect parent commit only if needed * Fix parent commit detection for initial commit * Improve logging * Improve current ref detection * Fix issue when base is a already fetched tag * Fix issue when base is a already fetched tag * Update README * Document usage with act * Use `git log` to get changes in latest commit * Disable other output for `git log` * get short name from base ref + improve loggig * update CHANGELOG	2020-09-30 00:32:49 +02:00
Michal Dorner	d9e86af7c0	Small improvement to project description	2020-09-14 18:49:18 +02:00
Michal Dorner	adb239d623	Add hint to use fetch-depth for feature branch workdlow	2020-09-14 18:09:37 +02:00
Michal Dorner	1f7b23edeb	Merge pull request #38 from dorny/develop Release v 2.3.0	2020-09-14 17:26:56 +02:00
Michal Dorner	bfc5803f5e	Add working-directory PR to changelog	2020-09-14 17:22:51 +02:00
Michal Dorner	b4f32c4f08	Reworked README for v2.3 release (#37 )	2020-09-14 17:19:32 +02:00
Michal Dorner	81c90ccae8	Change detection using git "three dot" diff (#35 ) * Rework change detection via `git diff` Previous implementation performed simple diff between two versions. New implementation fetches on demand more commits to have the merge base between two branches. Now it will detect only changes introduced by branch that was pushed, instead of mixing with changes introduced meanwhile on the base branch.	2020-09-01 22:47:38 +02:00
Michal Dorner	3f845744aa	Export files matching rules (#32 ) * Export files matching rules * Improve debug output * Fix PR test workflow * Always quote output path + fix PR test * Use proper single quote escaping in workflow file * Improve error handling and docs for list-files input parameter	2020-08-30 21:18:14 +02:00
Michal Dorner	483986d0a7	Merge branch 'master' into develop	2020-08-14 22:03:31 +02:00
Michal Dorner	3b817c9974	Add support for pull_request_target (#30 ) Complements previous commit: - adds modified index.js - bumps version to 2.2.1	2020-08-13 21:55:56 +02:00
Rob Dodson	b365bd8768	Update main.ts (#29 ) Add support for the new `pull_request_target` event. https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target	2020-08-13 21:44:57 +02:00
Michal Dorner	f34047f516	Export changed files grouped by change status (#23 )	2020-08-04 20:57:29 +02:00
Michal Dorner	1ff702da35	Extend filter syntax with optional specification of file status: add, modified, deleted (#22 ) * Add support for specification of change type (add,modified,delete) * Use NULL as separator in git-diff command output * Improve PR test workflow * Fix the workflow file	2020-08-04 20:57:29 +02:00
Michal Dorner	caef9bef1f	Add working-directory input (#21 )	2020-08-04 20:57:29 +02:00
Michal Dorner	14dd70c742	Add develop branch to PR verification	2020-08-04 20:57:29 +02:00
Daksh Shah	e1ae9889cb	Fix multiple jobs workflow example (#25 )	2020-07-16 12:33:30 +02:00
Michal Dorner	83deb9f037	Improve change detection for feature branches (#16 ) * Detect changes against configured base branch * Update README and action.yml * Add job.outputs example * Update CHANGELOG	2020-06-24 21:53:31 +02:00
Michal Dorner	7d201829e2	Support reusable paths blocks via yaml anchors (#13 ) * Add support for nested arrays of path expressions * Remove pull_request trigger type options Default value is fine: opened, synchronize, reopened * Add CHANGELOG * Update README	2020-06-19 23:39:06 +02:00
Michal Dorner	4eb15bc267	Update README Add links to pull_request / push events that trigger workflows	2020-06-15 22:15:38 +02:00
Michal Dorner	9ef7936e79	Fix URL in README	2020-06-15 21:57:00 +02:00
Michal Dorner	affb29871a	Support push event (#10 ) * Support triggering from push event * Add self-test to build workflow * Update action metadata	2020-06-15 21:49:10 +02:00
Tonye Jack	910e8b1235	Update README.md (#11 ) * Update README.md * Update version	2020-06-14 23:04:35 +02:00
Michal Dorner	1cbb925a17	Change detection via git + rename `githubToken` to `token` (#9 )	2020-05-26 17:16:09 +02:00
Michal Dorner	a2e5f9f7bb	Filters input accepts path to external yaml file (#8 ) * Filters input accepts path to external yaml file * Fix formatting and eslint issues * Fix file ext of filters yaml file * Update documentation in README file	2020-05-24 22:50:33 +02:00
Michal Dorner	0612377665	Do not require user provided `githubToken` input (configure default) (#7 ) * Do not require user provided `githubToken` input (configure default) * Remove `edited` from workflow example Idea of this example was to show setup where CI runs only when particular files are changed. Triggering workflow when name or description of PR is edited is not needed for this use case.	2020-05-24 21:17:51 +02:00
Michal Dorner	0c9e16cc6d	Update dependencies (#6 )	2020-05-23 14:23:31 +02:00
Michal Dorner	9b321c4b3a	Fix status badge	2020-05-21 14:56:45 +02:00
Michal Dorner	25327a213e	Fix README & status badge (#5 )	2020-05-21 14:53:14 +02:00