Fork

This action was forked from jitterbit/get-changed-files

Get Changed Files

Get files changed/modified in a pull request or push. 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

See action.yml

- uses: halaslabs/get-changed-files@v2
  with:
    # Format of the steps output context.
    # Can be 'space-delimited', 'csv', or 'json'.
    # Default: 'space-delimited'
    format: ''

Scenarios

• Get all changed files as space-delimited
• Get all added and modified files as CSV
• Get all removed files as JSON

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: halaslabs/get-changed-files@v2
- run: |
    for changed_file in ${{ steps.files.outputs.all }}; do
      echo "Do something with this ${changed_file}."
    done

Get all added and modified files as CSV

- id: files
  uses: halaslabs/get-changed-files@v2
  with:
    format: 'csv'
- 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: halaslabs/get-changed-files@v2
  with:
    format: 'json'
- 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

Get all files changed in specific directories

- id: files
  uses: halaslabs/get-changed-files@v2
  with:
    format: 'json'
    path-filters: |
      /.github/
      __tests__/**
- run: |
    readarray -t files <<<"$(jq -r '.[]' <<<'${{ steps.files.outputs.all }}')"
    for file in ${files[@]}; do
      echo "Do something with this ${file} from .github or tests/**"
    done

Get files changed but exclude some files by directory

- id: files
  uses: halaslabs/get-changed-files@v2
  with:
    format: 'json'
    path-exclusions: |
      /.github/
      __tests__/**
      
- run: |
    readarray -t files <<<"$(jq -r '.[]' <<<'${{ steps.files.outputs.all }}')"
    for file in ${files[@]}; do
      echo "Do something with this ${file} not from .github or tests/**"
    done

Get all files changed in specific directories and exclude a directory from the result set

- id: files
  uses: halaslabs/get-changed-files@v2
  with:
    format: 'json'
    path-filters: |
      /.github/
      __tests__/**
    path-exclusions: |
      /.github/workflows/**
      
- run: |
    readarray -t files <<<"$(jq -r '.[]' <<<'${{ steps.files.outputs.all }}')"
    for file in ${files[@]}; do
      echo "Do something with this ${file} from .github or tests/** but not from .github/workflows/**" 
    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