mirror of
https://github.com/tj-actions/changed-files
synced 2024-12-17 13:47:20 +00:00
107 lines
4.2 KiB
Markdown
107 lines
4.2 KiB
Markdown
[](https://github.com/tj-actions/changed-files/actions/workflows/test.yml) [](https://github.com/tj-actions/changed-files/actions/workflows/sync-release-version.yml)
|
|
|
|
changed-files
|
|
-------------
|
|
|
|
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.
|
|
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
...
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Get changed files using defaults
|
|
id: changed-files
|
|
uses: tj-actions/changed-files@v2.1
|
|
|
|
- name: Get changed files using a comma separator
|
|
id: changed-files-comma
|
|
uses: tj-actions/changed-files@v2.1
|
|
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."
|
|
|
|
|
|
```
|
|
|
|
|
|
## 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 (*) are selected if there <br/> is any file that matches other <br/> criteria in the comparison; <br/> if there is no file that <br/> matches other criteria, <br/> nothing is selected. |
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
|
|
* Free software: [MIT license](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](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.
|