get-changed-files

Get all changed/modified files 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 and added_modified_renamed. Renamed files that are also modified are included in renamed, modified and added_modified.

This project is a fork of jitterbit/get-changed-files, which:

• Supports pull_request_target
• Allows to filter files using regular expressions
• Removes the ahead check
• Considers renamed modified files as modified
• Adds added_modified_renamed that includes renamed non-modified files and all files in added_modified
• Removes node12 deprecation warnings

• Usage
  • Filtering
• Examples
  • Get all changed files as space-delimited
  • Get all changed *.php files as space-delimited
  • Get all changed *.yml files but exclude .github/*/*.yml files
  • Get all added and modified files as CSV
  • Get all removed files as JSON
• Install, Build, Lint, Test, and Package
• License

Usage

See action.yml

- uses: Ana06/[email protected]
  with:
    # Format of the steps output context.
    # Can be 'space-delimited', 'csv', or 'json'.
    # Default: 'space-delimited'
    format: ''
    # Filter files using a glob filter
    filter: '*'

Filtering

You can filter files using regular expressions with the filter option. This option receives a list of patterns using GitHub Actions syntax. You can use ! at the start of a pattern to negate previous positive patterns. See the Get all changed *.yml files but exclude .github/*/*.yml files example.

Examples

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.

- id: files
  uses: Ana06/[email protected]
- 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.

- id: files
  uses: Ana06/[email protected]
  with:
    filter: '*.php'
- run: |
    for changed_file in ${{ steps.files.outputs.all }}; do
      echo "Do something with this ${changed_file}."
    done

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.

- uses: Ana06/[email protected]
  with:
    filter: |
      *.yml
      !.github/*/*.yml

Get all added and modified files as CSV

- id: files
  uses: Ana06/[email protected]
  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

- id: files
  uses: Ana06/[email protected]
  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

Make sure to do the following before checking in any code changes.

yarn
yarn all

License

The scripts and documentation in this project are released under the MIT License