2021-09-20 00:41:05 +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) [](https://www.codacy.com/gh/tj-actions/changed-files/dashboard?utm\_source=github.com\&utm\_medium=referral\&utm\_content=tj-actions/changed-files\&utm\_campaign=Badge\_Grade) [](https://github.com/search?o=desc\&q=tj-actions+changed-files+language%3AYAML\&s=\&type=Code)
2021-09-19 23:58:07 +00:00
2021-09-20 00:47:25 +00:00
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob\_idruns-on)
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob\_idruns-on)
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob\_idruns-on)
2021-07-18 01:27:50 +00:00
2021-06-09 23:07:22 +00:00
<!-- ALL - CONTRIBUTORS - BADGE:START - Do not remove or modify this section -->
2021-08-28 01:58:49 +00:00
2021-09-20 00:41:05 +00:00
[](#contributors-)
2021-08-28 01:58:49 +00:00
2021-06-09 23:07:22 +00:00
<!-- ALL - CONTRIBUTORS - BADGE:END -->
2021-03-11 00:59:05 +00:00
2021-06-09 15:55:30 +00:00
## changed-files
2021-03-05 02:36:52 +00:00
2021-06-23 02:54:31 +00:00
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.
2021-05-25 21:39:15 +00:00
2021-05-01 17:15:09 +00:00
## Features
2021-06-23 13:34:52 +00:00
2021-09-28 23:33:00 +00:00
* Fast execution (0-2 seconds).
2021-09-20 00:45:52 +00:00
* Easy to debug.
2021-06-23 02:54:31 +00:00
* Boolean output indicating that certain files have been modified.
2021-08-28 01:58:32 +00:00
* Multiple repository support.
2021-06-09 15:55:30 +00:00
* 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.
2021-06-17 19:52:39 +00:00
* [Regex pattern ](https://www.gnu.org/software/grep/manual/grep.html#Regular-Expressions ) matching on a subset of files.
2021-05-01 17:15:09 +00:00
2021-05-04 17:53:26 +00:00
## Usage
2021-05-24 20:02:02 +00:00
> NOTE: :warning:
2021-06-09 15:55:30 +00:00
>
2021-06-25 11:24:10 +00:00
> * **IMPORTANT:** For `push` events you need to include `fetch-depth: 0` **OR** `fetch-depth: 2` depending on your use case.
2021-06-09 15:55:30 +00:00
> * When using `persist-credentials: false` with `actions/checkout@v2` you'll need to specify a `token` using the `token` input.
2021-05-04 17:53:26 +00:00
```yaml
name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
2021-06-18 17:38:07 +00:00
runs-on: ubuntu-latest # windows-latest | macos-latest
2021-05-04 17:53:26 +00:00
name: Test changed-files
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
2021-08-28 01:53:03 +00:00
2021-05-04 17:53:26 +00:00
- name: Get changed files
id: changed-files
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-08-28 01:53:03 +00:00
2021-05-04 17:53:26 +00:00
- name: List all modified files
run: |
for file in "${{ steps.changed-files.outputs.all_modified_files }}"; do
echo "$file was modified"
done
```
2021-04-24 08:49:18 +00:00
## Outputs
| Acronym | Meaning |
|:---------:|:------------:|
| A | Added |
| C | Copied |
2021-06-09 13:31:52 +00:00
| M | Modified |
2021-04-24 08:49:18 +00:00
| D | Deleted |
| R | Renamed |
| T | Type changed |
| U | Unmerged |
| X | Unknown |
2021-06-09 13:31:52 +00:00
| Output | type | example | description |
|:--------------------:|:------------:|:----------------------------------:|:----------------------------------------:|
2021-09-20 00:41:05 +00:00
| any\_changed | `string` | `true` OR `false` | Returns `true` when any < br /> of the filenames provided using < br /> the `files` input has changed. < br /> i.e. *using a combination of all added, <br />copied, modified and renamed files (ACMR).* |
| only\_changed | `string` | `true` OR `false` | Returns `true` when only < br /> files provided using < br /> the `files` input have changed. (ACMR) |
| other\_changed\_files | `string` | `'new.txt path/to/file.png ...'` | Select all other changed files < br /> not listed in the files input < br /> i.e. *a combination of all added, <br /> copied and modified files (ACMR).* |
| any\_deleted | `string` | `true` OR `false` | Returns `true` when any < br /> of the filenames provided using < br /> the `files` input has been deleted. (D).\* |
| only\_deleted | `string` | `true` OR `false` | Returns `true` when only < br /> files provided using < br /> the `files` input has been deleted. (D) |
| other\_deleted\_files | `string` | `'new.txt path/to/file.png ...'` | Select all other deleted files < br /> not listed in the files input < br /> i.e. *a combination of all deleted files (D).* |
| all\_modified\_files | `string` | `'new.txt path/to/file.png ...'` | Select all modified files < br /> i.e. a combination of all added, < br /> copied, modified and renamed files (ACMR).\* |
| all\_changed\_and\_modified\_files | `string` | `'new.txt path/to/file.png ...'` | Select all changed < br /> and modified files < br /> i.e. *a combination of (ACMRDTUX).* |
| 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) |
2021-04-24 08:49:18 +00:00
## Inputs
| Input | type | required | default | description |
2021-06-09 13:31:52 +00:00
|:-------------:|:-----------:|:-------------:|:-----------------------------:|:-------------:|
2021-09-20 00:41:05 +00:00
| token | `string` | `false` | `${{ github.token }}` | [GITHUB\_TOKEN ](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github\_token-in-a-workflow ) < br /> or a repo scoped < br /> [Personal Access Token ](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token ) |
2021-06-09 13:31:52 +00:00
| separator | `string` | `true` | `' '` | Output string separator |
2021-07-17 15:01:24 +00:00
| files | `string` OR `string[]` | `false` | | Check for changes < br > using only these < br > list of file(s) < br > (Defaults to the < br > entire repo) |
2021-09-20 00:41:05 +00:00
| base\_sha | `string` | `false` | | Specify a different < br > base commit SHA < br > used for < br > comparing changes |
2021-07-17 15:49:12 +00:00
| sha | `string` | `true` | `${{ github.sha }}` | Specify a different < br > commit SHA < br > used for < br > comparing changes |
2021-09-20 00:41:05 +00:00
| files\_from\_source\_file | `string` | `false` | | Source file < br > used to populate < br > the files input |
2021-08-28 01:53:03 +00:00
| path | `string` | `false` | | Relative path under < br > `GITHUB_WORKSPACE` < br > to the repository |
2021-04-24 08:49:18 +00:00
2021-04-04 13:11:55 +00:00
## Example
2021-03-14 19:42:54 +00:00
```yaml
...
steps:
- uses: actions/checkout@v2
2021-05-07 21:46:34 +00:00
2021-04-01 11:43:05 +00:00
- name: Get changed files using defaults
2021-04-27 16:07:27 +00:00
id: changed-files
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-08-28 01:53:03 +00:00
2021-04-01 11:43:05 +00:00
- name: Get changed files using a comma separator
2021-04-27 16:07:27 +00:00
id: changed-files-comma
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-03-14 19:42:54 +00:00
with:
separator: ","
2021-05-01 16:17:17 +00:00
2021-03-14 19:42:54 +00:00
- name: List all added files
run: |
2021-04-27 16:07:27 +00:00
for file in "${{ steps.changed-files.outputs.added_files }}"; do
2021-04-24 08:55:30 +00:00
echo "$file was added"
2021-03-14 19:42:54 +00:00
done
2021-05-01 16:17:17 +00:00
2021-04-24 08:57:13 +00:00
- name: Run step when a file changes
2021-04-27 16:07:27 +00:00
if: contains(steps.changed-files.outputs.modified_files, 'my-file.txt')
2021-04-02 12:08:05 +00:00
run: |
2021-05-01 17:03:29 +00:00
echo "Your file my-file.txt has been modified."
2021-04-02 12:08:05 +00:00
2021-04-24 08:57:13 +00:00
- name: Run step when a file has been deleted
2021-04-27 16:07:27 +00:00
if: contains(steps.changed-files.outputs.deleted_files, 'test.txt')
2021-04-02 12:08:05 +00:00
run: |
2021-05-01 17:03:29 +00:00
echo "Your test.txt has been deleted."
2021-05-01 16:17:17 +00:00
- name: Get specific changed files
id: changed-files-specific
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-05-01 16:17:17 +00:00
with:
files: |
my-file.txt
test.txt
2021-05-01 17:15:09 +00:00
new.txt
test_directory
2021-09-28 02:12:45 +00:00
\.sh$
2021-08-28 01:53:03 +00:00
.(png|jpeg)$
2021-09-28 02:12:45 +00:00
.(sql|py)$
2021-05-01 17:15:09 +00:00
^(mynewfile|custom)
2021-05-01 16:17:17 +00:00
2021-07-16 15:29:34 +00:00
- 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."
2021-08-28 01:53:03 +00:00
2021-07-20 19:32:52 +00:00
- name: Run step if only the files listed above change
if: steps.changed-files-specific.outputs.only_changed == 'true'
run: |
echo "Only files listed above have changed."
2021-08-28 01:53:03 +00:00
2021-09-05 12:22:47 +00:00
- name: Run step if any of the listed files above is deleted
if: steps.changed-files.outputs.any_deleted == "true"
run: |
for file in "${{ steps.changed-files.outputs.deleted_files }}"; do
echo "$file was deleted"
done
- name: Run step if all listed files above have been deleted
if: steps.changed-files.outputs.only_deleted == "true"
run: |
for file in "${{ steps.changed-files.outputs.deleted_files }}"; do
echo "$file was deleted"
done
2021-07-17 14:51:08 +00:00
- name: Use a source file or list of file(s) to populate to files input.
id: changed-files-specific-source-file
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-07-17 14:51:08 +00:00
with:
2021-07-17 15:46:59 +00:00
files_from_source_file: |
2021-07-17 14:51:08 +00:00
test/changed-files-list.txt
- name: Use a source file or list of file(s) to populate to files input and optionally specify more files.
id: changed-files-specific-source-file-and-specify-files
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-07-17 14:51:08 +00:00
with:
2021-07-17 15:46:59 +00:00
files_from_source_file: |
2021-07-17 14:51:08 +00:00
test/changed-files-list.txt
files: |
.github/workflows/rebase.yml
2021-07-16 15:29:34 +00:00
- name: Use a different commit SHA
2021-07-17 15:53:36 +00:00
id: changed-files-custom-sha
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-07-14 20:57:17 +00:00
with:
sha: ${{ github.event.pull_request.head.sha }}
2021-08-28 01:53:03 +00:00
2021-07-17 15:52:34 +00:00
- name: Use a different base SHA
id: changed-files-custom-base-sha
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-07-17 15:52:34 +00:00
with:
base_sha: "2096ed0"
2021-08-28 02:01:21 +00:00
- name: Checkout into dir1
uses: actions/checkout@v2
with:
fetch-depth: 0
2021-09-06 15:09:47 +00:00
path: dir1
2021-08-28 02:01:21 +00:00
- name: Run changed-files with defaults on the dir1
2021-09-06 15:09:47 +00:00
id: changed-files-for-dir1
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-08-28 02:01:21 +00:00
with:
2021-09-06 15:09:47 +00:00
path: dir1
- name: List all added files in dir1
run: |
for file in "${{ steps.changed-files-for-dir1.outputs.added_files }}"; do
echo "$file was added"
done
2021-03-14 19:42:54 +00:00
```
2021-04-11 22:27:34 +00:00
### Running [pre-commit](https://pre-commit.com/) on all modified files
```yaml
...
steps:
- uses: actions/checkout@v2
with:
2021-05-06 13:25:34 +00:00
fetch-depth: 0
2021-08-28 01:53:03 +00:00
2021-04-11 22:27:34 +00:00
- name: Get changed files
2021-04-27 16:07:27 +00:00
id: changed-files
2021-09-26 06:40:13 +00:00
uses: tj-actions/changed-files@v1.1.3
2021-04-11 22:27:34 +00:00
- name: Pre-commit
uses: pre-commit/action@v2.0.0
with:
2021-04-27 16:07:27 +00:00
extra_args: -v --hook-stage push --files ${{ steps.changed-files.outputs.all_modified_files }}
2021-04-11 22:27:34 +00:00
token: ${{ secrets.github_token }}
```
2021-07-06 18:51:18 +00:00
2021-07-17 14:54:03 +00:00
2021-06-09 15:55:30 +00:00
* Free software: [MIT license ](LICENSE )
2021-03-05 02:36:52 +00:00
2021-06-05 20:51:43 +00:00
If you feel generous and want to show some extra appreciation:
2021-06-26 16:12:28 +00:00
Support me with a :star:
2021-06-05 20:51:43 +00:00
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
2021-06-09 15:55:30 +00:00
## Credits
2021-03-05 02:36:52 +00:00
This package was created with [Cookiecutter ](https://github.com/cookiecutter/cookiecutter ).
2021-06-09 15:55:30 +00:00
## Report Bugs
2021-03-05 02:36:52 +00:00
Report bugs at https://github.com/tj-actions/changed-files/issues.
If you are reporting a bug, please include:
2021-06-09 15:55:30 +00:00
* Your operating system name and version.
* Any details about your workflow that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
2021-06-09 23:07:22 +00:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
2021-08-28 01:58:49 +00:00
2021-06-09 23:07:22 +00:00
<!-- prettier - ignore - start -->
2021-08-28 01:58:49 +00:00
2021-06-09 23:07:22 +00:00
<!-- markdownlint - disable -->
2021-08-28 01:58:49 +00:00
2021-06-09 23:07:22 +00:00
< table >
< tr >
< td align = "center" > < a href = "https://github.com/jsoref" > < img src = "https://avatars.githubusercontent.com/u/2119212?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Josh Soref< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=jsoref" title = "Documentation" > 📖< / a > < / td >
2021-06-09 23:12:15 +00:00
< td align = "center" > < a href = "https://github.com/monoxgas" > < img src = "https://avatars.githubusercontent.com/u/1223016?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Nick Landers< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=monoxgas" title = "Code" > 💻< / a > < / td >
2021-07-14 20:58:53 +00:00
< td align = "center" > < a href = "https://github.com/Kras4ooo" > < img src = "https://avatars.githubusercontent.com/u/1948054?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Krasimir Nikolov< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=Kras4ooo" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=Kras4ooo" title = "Documentation" > 📖< / a > < / td >
2021-08-28 01:57:25 +00:00
< td align = "center" > < a href = "https://github.com/IvanPizhenko" > < img src = "https://avatars.githubusercontent.com/u/11859904?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Ivan Pizhenko< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=IvanPizhenko" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=IvanPizhenko" title = "Documentation" > 📖< / a > < / td >
2021-06-09 23:07:22 +00:00
< / tr >
< / table >
<!-- markdownlint - restore -->
2021-08-28 01:58:49 +00:00
2021-06-09 23:07:22 +00:00
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2021-06-10 01:01:10 +00:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
2021-07-01 20:13:38 +00:00
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
