Retrieve all changed files relative to the default branch (pull_request* based events) or a previous commit (push based event) returning the absolute path to all changed files from the project root.
- Boolean output indicating that certain files have been modified.
- List all files that have changed.
- Between the current pull request branch and the default branch.
- Between the last commit and the current pushed change.
- Restrict change detection to a subset of files.
- Report on files that have at least one change.
- Regex pattern matching on a subset of files.
NOTE:
⚠️
- IMPORTANT: For
pushevents you need to includefetch-depth: 0ORfetch-depth: 2depending on your use case.- When using
persist-credentials: falsewithactions/checkout@v2you'll need to specify atokenusing thetokeninput.
name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest # windows-latest | macos-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/[email protected]
- name: List all modified files
run: |
for file in "${{ steps.changed-files.outputs.all_modified_files }}"; do
echo "$file was modified"
done| Acronym | Meaning |
|---|---|
| A | Added |
| C | Copied |
| M | Modified |
| D | Deleted |
| R | Renamed |
| T | Type changed |
| U | Unmerged |
| X | Unknown |
| Output | type | example | description |
|---|---|---|---|
| any_changed | string |
true OR false |
Returns true when any of the filenames provided using the files input has changed |
| all_modified_files | string |
'new.txt path/to/file.png ...' |
Select all modified files i.e. a combination of all added, copied and modified files (ACM). |
| all_changed_files | string |
'new.txt path/to/file.png ...' |
Select all paths (*) i.e. a combination of all options below. |
| added_files | string |
'new.txt path/to/file.png ...' |
Select only files that are Added (A) |
| copied_files | string |
'new.txt path/to/file.png ...' |
Select only files that are Copied (C) |
| deleted_files | string |
'new.txt path/to/file.png ...' |
Select only files that are Deleted (D) |
| modified_files | string |
'new.txt path/to/file.png ...' |
Select only files that are Modified (M) |
| renamed_files | string |
'new.txt path/to/file.png ...' |
Select only files that are Renamed (R) |
| type_changed_files | string |
'new.txt path/to/file.png ...' |
Select only files that have their file type changed (T) |
| unmerged_files | string |
'new.txt path/to/file.png ...' |
Select only files that are Unmerged (U) |
| unknown_files | string |
'new.txt path/to/file.png ...' |
Select only files that are Unknown (X) |
| Input | type | required | default | description |
|---|---|---|---|---|
| token | string |
false |
${{ github.token }} |
GITHUB_TOKEN or a repo scoped Personal Access Token |
| separator | string |
true |
' ' |
Output string separator |
| files | string OR string[] |
false |
Check for changes using only these list of file(s) (Defaults to the entire repo) |
...
steps:
- uses: actions/checkout@v2
- name: Get changed files using defaults
id: changed-files
uses: tj-actions/[email protected]
- name: Get changed files using a comma separator
id: changed-files-comma
uses: tj-actions/[email protected]
with:
separator: ","
- name: List all added files
run: |
for file in "${{ steps.changed-files.outputs.added_files }}"; do
echo "$file was added"
done
- name: Run step when a file changes
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 has been deleted
if: contains(steps.changed-files.outputs.deleted_files, 'test.txt')
run: |
echo "Your test.txt has been deleted."
- name: Get specific changed files
id: changed-files-specific
uses: tj-actions/[email protected]
with:
files: |
my-file.txt
test.txt
new.txt
test_directory
.(png|jpeg)$
.(sql)$
^(mynewfile|custom)
- name: Run step if any of the listed files above change
if: steps.changed-files-specific.outputs.any_changed == 'true'
run: |
echo "One or more files listed above has changed."
- name: Add custom source sha
id: changed-files-comma
uses: tj-actions/[email protected]
with:
sha: ${{ github.event.pull_request.head.sha }}
Running pre-commit on all modified files
...
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Get changed files
id: changed-files
uses: tj-actions/[email protected]
- name: Pre-commit
uses: pre-commit/[email protected]
with:
extra_args: -v --hook-stage push --files ${{ steps.changed-files.outputs.all_modified_files }}
token: ${{ secrets.github_token }}
- Free software: MIT license
If you feel generous and want to show some extra appreciation:
Support me with a ⭐
This package was created with Cookiecutter.
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.
Thanks goes to these wonderful people (emoji key):
 Josh Soref 📖 |
 Nick Landers 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!
![allcontributors[bot] avatar](https://avatars.githubusercontent.com/in/23186?v=4 "allcontributors[bot]")
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent