changed-files/README.md

changed-files

Get all modified files relative to the default branch or preceding commit.

NOTE: ⚠️ This action should only run on the following events ⚠️

• push
• pull_request
• pull_request_review
• pull_request_review_comment
• pull_request_target

Usage

Push event

name: CI

on:
  push:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest
    name: Test changed-files
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0  # OR "2" -> To retrieve the preceding commit.
      - name: Get changed files
        id: changed_files
        uses: tj-actions/changed-files@v4

Pull Request events

name: CI

on:
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest
    name: Test changed-files
    steps:
      - uses: actions/checkout@v2
      - name: Get changed files
        id: changed_files
        uses: tj-actions/changed-files@v4

Example

...
    steps:
      - uses: actions/checkout@v2
      - name: Get changed files using defaults
        id: changed_files
        uses: tj-actions/changed-files@v4
      
      - name: Get changed files using a comma separator
        id: changed_files_comma
        uses: tj-actions/changed-files@v4
        with:
          separator: ","
       
      - name: List all added files
        run: |
          for file in "${{ steps.changed_files.outputs.added_files }}"; do
            echo $file
          done
                    
      - name: Run step when a file changes in a PR relative to the default branch
        if: contains(steps.changed_files.outputs.modified_files, 'my-file.txt')
        run: |
            echo "Your file my-file.txt has been modified."            

      - name: Run step when a file is deleted in a PR relative to the default branch
        if: contains(steps.changed_files.outputs.deleted_files, 'test.txt')
        run: |
            echo "Your test.txt has been deleted."
                        
        

Running pre-commit on all modified files

...
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0  # otherwise, you will fail to push refs to dest repo
      
      - name: Get changed files
        id: changed_files
        uses: tj-actions/changed-files@v4

      - name: Pre-commit
        uses: pre-commit/action@v2.0.0
        with:
          extra_args: -v --hook-stage push --files ${{ steps.changed_files.outputs.all_modified_files }}
          token: ${{ secrets.github_token }}

Inputs

Input	type	required	default	description
separator	string	true	' '	Separator to return outputs

Outputs

Using the default separator.

Output	type	example	description
added_files	string	'new.txt other.png ...'	Select only files that are Added (A)
copied_files	string	'new.txt other.png ...'	Select only files that are Copied (C)
deleted_files	string	'new.txt other.png ...'	Select only files that are Deleted (D)
modified_files	string	'new.txt other.png ...'	Select only files that are Modified (M)
renamed_files	string	'new.txt other.png ...'	Select only files that are Renamed (R)
changed_files	string	'new.txt other.png ...'	Select only files that have their type changed (T)
unmerged_files	string	'new.txt other.png ...'	Select only files that are Unmerged (U)
unknown_files	string	'new.txt other.png ...'	Select only files that are Unknown (X)
all_changed_files	string	'new.txt other.png ...'	Select all paths (*) i.e a combination of all options above.
all_modified_files	string	'new.txt other.png ...'	Select all modified files i.e a combination of all added, copied and modified files (ACM).

Example

• Free software: MIT license

Features

• Added Files
• Copied Files
• Deleted Files
• Modified Files
• Renamed Files
• Changed Files
• Unmerged Files
• Unknown Files
• All Changed Files

Credits

This package was created with Cookiecutter.

Report Bugs

Report bugs at https://github.com/tj-actions/changed-files/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your workflow that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.