2021-03-11 00:59:43 +00:00
[](https://github.com/tj-actions/changed-files/actions/workflows/test.yml) [](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml)
2021-03-11 00:59:05 +00:00
2021-03-05 02:36:52 +00:00
changed-files
-------------
2021-03-08 21:03:04 +00:00
Get modified files using [`git diff --diff-filter` ](https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203 ) to locate all files that have been modified relative to the default branch.
2021-03-05 02:36:52 +00:00
2021-04-02 13:17:01 +00:00
> NOTE: :warning: This action should only run on the following events :warning:
> * [pull_request](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request)
> * [pull_request_review](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_review)
> * [pull_request_review_comment](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_review_comment)
> * [pull_request_target](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target)
2021-03-11 00:57:53 +00:00
2021-03-14 19:42:54 +00:00
## Usage
```yaml
...
steps:
- uses: actions/checkout@v2
2021-04-01 11:43:05 +00:00
- name: Get changed files using defaults
2021-03-14 19:42:54 +00:00
id: changed-files
2021-04-04 13:01:55 +00:00
uses: tj-actions/changed-files@v3.1
2021-03-14 19:42:54 +00:00
2021-04-01 11:43:05 +00:00
- name: Get changed files using a comma separator
2021-03-14 19:42:54 +00:00
id: changed-files-comma
2021-04-04 13:01:55 +00:00
uses: tj-actions/changed-files@v3.1
2021-03-14 19:42:54 +00:00
with:
separator: ","
- name: List all added files
run: |
for file in "${{ steps.changed-files.outputs.added_files }}"; do
echo $file
done
2021-04-02 12:08:05 +00:00
- name: Run step when a file changes in a PR relative to the default branch
2021-04-02 13:13:22 +00:00
if: contains(steps.changed-files.outputs.modified_files, 'my-file.txt')
2021-04-02 12:08:05 +00:00
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
2021-04-02 13:13:22 +00:00
if: contains(steps.changed-files.outputs.deleted_files, 'test.txt')
2021-04-02 12:08:05 +00:00
run: |
echo "Your test.txt has been deleted."
2021-03-14 19:42:54 +00:00
```
2021-03-11 00:57:53 +00:00
## 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) |
2021-04-02 16:06:01 +00:00
| all_changed_files | `string` | 'new.txt other.png ...' | Select all paths (*) < br /> *i.e a combination of all options above.* |
2021-03-11 00:57:53 +00:00
2021-04-02 12:22:12 +00:00
## Example
2021-04-02 13:06:46 +00:00
2021-04-02 12:22:12 +00:00
2021-03-05 02:36:52 +00:00
* Free software: [MIT license ](LICENSE )
2021-03-11 00:57:53 +00:00
2021-03-05 02:36:52 +00:00
Features
--------
2021-03-05 12:44:03 +00:00
- Added Files
- Copied Files
- Deleted Files
- Modified Files
- Renamed Files
- Changed Files
- Unmerged Files
- Unknown Files
- All Changed Files
2021-03-05 02:36:52 +00:00
Credits
-------
This package was created with [Cookiecutter ](https://github.com/cookiecutter/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.
