mirror of
https://github.com/tj-actions/changed-files
synced 2024-12-16 19:27:39 +00:00
7.9 KiB
7.9 KiB
changed-files
Get all modified files relative to the default branch (pull_request*
events) or last commit (push
event).
Features
- 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 all changed.
- Report on files that have at least one file change.
- Regex pattern matching on a subset of files.
Usage
NOTE: ⚠️
- For
push
events to work you need to includefetch-depth: 0
ORfetch-depth: 2
depending on your use case.- When using
persist-credentials: false
withactions/checkout@v2
action you need to specify thetoken
using thetoken
input.
name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
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@v5.1
- name: List all modified files
run: |
for file in "${{ steps.changed-files.outputs.all_modified_files }}"; do
echo "$file was modified"
done
Outputs
Acronym | Meaning |
---|---|
A | Added |
C | Copied |
M | Modified. |
D | Deleted |
R | Renamed |
T | Type changed |
U | Unmerged |
X | Unknown |
Output | type | example | description |
---|---|---|---|
all_changed | string |
true OR false |
Returns true only when the filenames provided using files input have all changed |
any_changed | string |
true OR false |
Returns true when any of the filenames provided using files input have changed |
all_modified_files | string |
'new.txt other.png ...' |
Select all modified files i.e a combination of all added, copied and modified files (ACM). |
all_changed_files | string |
'new.txt other.png ...' |
Select all paths (*) i.e a combination of all options below. |
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 file 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) |
Inputs
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 |
Restricted list of specific files to watch for changes |
Example
...
steps:
- uses: actions/checkout@v2
- name: Get changed files using defaults
id: changed-files
uses: tj-actions/changed-files@v5.1
- name: Get changed files using a comma separator
id: changed-files-comma
uses: tj-actions/changed-files@v5.1
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/changed-files@v5.1
with:
files: |
my-file.txt
test.txt
new.txt
test_directory
.(py|jpeg)$
.(sql)$
^(mynewfile|custom)
- name: Run step if all files listed above have changed
if: steps.changed-files-specific.outputs.all_changed == 'true'
run: |
echo "Both my-file.txt and test.txt have changed."
- name: Run step if any of the listed files above change
if: steps.changed-files-specific.outputs.any_changed == 'true'
run: |
echo "Either my-file.txt or test.txt have changed."
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@v5.1
- 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 }}
Example
- Free software: MIT license
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.