2023-02-16 00:55:26 +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)
[](https://github.com/search?o=desc\&q=tj-actions+changed-files+language%3AYAML\&s=\&type=Code)
2023-02-16 00:54:23 +00:00
2021-11-24 20:25:57 +00:00
[](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)
2022-10-31 01:21:40 +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-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 -->
2023-01-05 18:00:54 +00:00
2023-01-05 17:58:53 +00:00
[](#contributors-)
2023-01-05 18:00:54 +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
2023-02-22 15:39:38 +00:00
Retrieve all changed files and directories relative to the target branch or the last remote commit returning a **relative path** from the project root.
2022-08-17 19:33:07 +00:00
2021-05-01 17:15:09 +00:00
## Features
2021-06-23 13:34:52 +00:00
2023-01-02 04:40:36 +00:00
* Fast execution (0-10 seconds on average).
2021-09-20 00:45:52 +00:00
* Easy to debug.
2022-03-20 17:30:55 +00:00
* Scales to large repositories.
2023-02-07 01:09:57 +00:00
* Supports Git submodules.
2023-02-22 08:00:59 +00:00
* Escaped JSON output which can be used to run matrix jobs based on changed files.
2023-02-09 19:47:53 +00:00
* List changed directories.
2022-12-12 08:36:53 +00:00
* Restrict the max depth of changed directories.
2023-03-13 18:06:26 +00:00
* Write outputs to a `.txt` or `.json` file at a specified location for further processing.
2023-02-22 08:03:16 +00:00
* Monorepos (Fetches a fixed number of commits).
2022-05-19 12:03:53 +00:00
* Supports all platforms (Linux, MacOS, Windows).
2022-02-03 19:15:41 +00:00
* [GitHub-hosted runners ](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners ) support
2022-02-02 21:09:18 +00:00
* [GitHub Enterprise Server ](https://docs.github.com/en/enterprise-server@3.3/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server ) support.
2022-02-03 19:15:41 +00:00
* [self-hosted runners ](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners ) support.
2022-06-13 04:00:23 +00:00
* List all files and directories that have changed:
2022-02-17 08:03:01 +00:00
* Between the current pull request branch and the last commit on the target branch.
2021-06-09 15:55:30 +00:00
* Between the last commit and the current pushed change.
2021-10-31 00:13:18 +00:00
* Between the last remote branch commit and the current HEAD.
2022-06-13 04:00:23 +00:00
* Restrict change detection to a subset of files and directories:
2022-09-24 18:36:07 +00:00
* Boolean output indicating that certain files have been changed.
2022-01-09 17:11:39 +00:00
* Using [Glob pattern ](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet ) matching.
2023-02-04 21:44:21 +00:00
* Brace expansion.
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.
2022-01-07 18:51:45 +00:00
> * For monorepos where pulling all the branch history might not be desired, you can omit `fetch-depth` for `pull_request` events.
2022-05-14 06:37:55 +00:00
> * For files located in a sub-directory ensure that the pattern specified contains `**/` (globstar) to match any preceding directories or explicitly pass the full path relative to the project root. See: [#314](https://github.com/tj-actions/changed-files/issues/314).
2023-02-26 03:54:48 +00:00
> * All multiline inputs should not use double or single quotes since the value is already a string seperated by a newline character. See [Examples](#examples) for more information.
2023-01-05 18:20:14 +00:00
> * Ensure that `persist-credentials` is set to `true` when configuring `actions/checkout` if `fetch-depth` isn't set to `0`.
2021-05-04 17:53:26 +00:00
```yaml
name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
2023-03-12 10:01:54 +00:00
# -------------------------------------------------------------------------------------------------------------------------
# Event `push`: Compare the preceeding commit -> to the current commit of the main branch.
# Event `pull_request`: Compare the last commit of main -> to the current commit of a Pull Request branch.
# -------------------------------------------------------------------------------------------------------------------------
2021-05-04 17:53:26 +00:00
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:
2022-03-30 03:50:08 +00:00
- uses: actions/checkout@v3
2021-05-04 17:53:26 +00:00
with:
fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
2022-10-21 14:44:19 +00:00
2022-09-12 20:50:21 +00:00
# Example 1
2021-05-04 17:53:26 +00:00
- name: Get changed files
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2023-03-12 10:01:54 +00:00
2023-03-07 22:48:59 +00:00
# To compare changes between the current commit and the last pushed remote commit set `since_last_remote_commit: true` . e.g
2023-03-07 22:48:22 +00:00
# with:
# since_last_remote_commit: true
2021-08-28 01:53:03 +00:00
2021-12-14 05:21:49 +00:00
- name: List all changed files
2021-05-04 17:53:26 +00:00
run: |
2021-12-14 05:21:49 +00:00
for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
echo "$file was changed"
2021-05-04 17:53:26 +00:00
done
2022-10-21 14:44:19 +00:00
2022-09-12 20:50:21 +00:00
# Example 2
2022-09-12 20:49:21 +00:00
- name: Get changed files in the docs folder
2022-09-12 20:47:54 +00:00
id: changed-files-specific
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-09-12 20:47:54 +00:00
with:
2023-01-13 19:16:39 +00:00
files: docs/*.{js,html} # Alternatively using: `docs/**` or `docs`
2022-09-12 20:47:54 +00:00
- name: Run step if any file(s) in the docs folder change
if: steps.changed-files-specific.outputs.any_changed == 'true'
run: |
echo "One or more files in the docs folder has changed."
2022-09-12 20:50:56 +00:00
echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}"
2023-01-25 15:14:32 +00:00
# Example 3
- name: Get changed js files excluding the docs folder
id: changed-files-excluded
uses: tj-actions/changed-files@v35
with:
files: |
** /*.js
files_ignore: docs/** # Alternatively using: `docs`
- name: Run step if any other js file(s) change
if: steps.changed-files-excluded.outputs.any_changed == 'true'
run: |
echo "One or more js files not in the doc folder has changed."
echo "List all the files that have changed: ${{ steps.changed-files-excluded.outputs.all_changed_files }}"
2021-05-04 17:53:26 +00:00
```
2021-11-24 19:04:39 +00:00
If you feel generous and want to show some extra appreciation:
Support this project with a :star:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
2022-10-29 21:48:36 +00:00
## Useful Acronyms
2021-04-24 08:49:18 +00:00
2022-02-17 07:35:49 +00:00
| Acronym | Meaning |
2021-04-24 08:49:18 +00:00
|:---------:|:------------:|
2022-02-17 07:35:49 +00:00
| A | Added |
| C | Copied |
| M | Modified |
| D | Deleted |
| R | Renamed |
| T | Type changed |
| U | Unmerged |
| X | Unknown |
2022-10-29 21:48:36 +00:00
## Outputs
<!-- AUTO - DOC - OUTPUT:START - Do not remove or modify this section -->
2022-12-30 09:34:56 +00:00
| OUTPUT | TYPE | DESCRIPTION |
|--------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| added\_files | string | Returns only files that are Added< br > (A). |
| all\_changed\_and\_modified\_files | string | Returns all changed and modified files< br > i.e. *a combination of (ACMRDTUX)* |
| all\_changed\_files | string | Returns all changed files i.e. *a<br> combination of all added, copied, modified<br>and renamed files (ACMR)* |
| all\_modified\_files | string | Returns all changed files i.e. *a<br> combination of all added, copied, modified,<br>renamed and deleted files (ACMRD)* . |
| all\_old\_new\_renamed\_files | string | Returns only files that are Renamed< br > and list their old and new< br > names. **NOTE:** This requires setting `include_all_old_new_renamed_files` < br > to `true` (R) |
| any\_changed | string | Returns `true` when any of the< br > filenames provided using the `files` input< br > has changed. If no `files` have< br > been specified,an empty string `''` is< br > returned. i.e. *using a combination of<br> all added, copied, modified and renamed<br>files (ACMR)* . |
| any\_deleted | string | Returns `true` when any of the< br > filenames provided using the `files` input< br > has been deleted. If no `files` < br > have been specified,an empty string `''` < br > is returned. (D) |
| any\_modified | string | Returns `true` when any of the< br > filenames provided using the `files` input< br > has been modified. If no `files` < br > have been specified,an empty string `''` < br > is returned. i.e. *using a combination<br> of all added, copied, modified, renamed,<br>and deleted files (ACMRD)* . |
| copied\_files | string | Returns only files that are Copied< br > (C). |
| deleted\_files | string | Returns only files that are Deleted< br > (D). |
| modified\_files | string | Returns only files that are Modified< br > (M). |
2022-12-31 03:59:38 +00:00
| only\_changed | string | Returns `true` when only files provided< br > using the `files` input has changed.< br > If no `files` have been specified,an< br > empty string `''` is returned. i.e.< br > *using a combination of all added,<br>copied, modified and renamed files (ACMR)* . |
2022-12-30 09:34:56 +00:00
| only\_deleted | string | Returns `true` when only files provided< br > using the `files` input has been< br > deleted. If no `files` have been< br > specified,an empty string `''` is returned.< br > (D) |
2022-12-31 03:59:38 +00:00
| only\_modified | string | Returns `true` when only files provided< br > using the `files` input has been< br > modified. If no `files` have been< br > specified,an empty string `''` is returned.(ACMRD). |
| other\_changed\_files | string | Returns all other changed files not< br > listed in the files input i.e.< br > *using a combination of all added,<br>copied, modified and renamed files (ACMR)* . |
2022-12-30 09:34:56 +00:00
| other\_deleted\_files | string | Returns all other deleted files not< br > listed in the files input i.e.< br > *a combination of all deleted files<br>(D)* |
| other\_modified\_files | string | Returns all other modified files not< br > listed in the files input i.e.< br > *a combination of all added, copied,<br>modified, and deleted files (ACMRD)* |
| renamed\_files | string | Returns only files that are Renamed< br > (R). |
| type\_changed\_files | string | Returns only files that have their< br > file type changed (T). |
| unknown\_files | string | Returns only files that are Unknown< br > (X). |
| unmerged\_files | string | Returns only files that are Unmerged< br > (U). |
2022-10-29 21:48:36 +00:00
<!-- AUTO - DOC - OUTPUT:END -->
2021-04-24 08:49:18 +00:00
## Inputs
2022-10-29 21:48:36 +00:00
<!-- AUTO - DOC - INPUT:START - Do not remove or modify this section -->
2022-12-30 09:34:56 +00:00
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------------------------------|--------|----------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| base\_sha | string | false | | Specify a different base commit SHA< br > used for comparing changes |
| diff\_relative | string | false | | Exclude changes outside the current directory< br > and show path names relative to< br > it. **NOTE:** This requires you to< br > specify the top level directory via< br > the `path` input. |
| dir\_names | string | false | `"false"` | Output unique changed directories instead of< br > filenames. **NOTE:** This returns `.` for< br > changed files located in the root< br > of the project. |
2023-02-01 01:53:59 +00:00
| dir\_names\_exclude\_root | string | false | `"false"` | Exclude the root directory represented by< br > `.` from the output when `dir_names` is< br > set to `true` . |
2022-12-30 09:34:56 +00:00
| dir\_names\_max\_depth | string | false | | Maximum depth of directories to output.< br > e.g `test/test1/test2` with max depth of< br > `2` returns `test/test1` . |
| fetch\_depth | string | false | `"50"` | Depth of additional branch history fetched.< br > **NOTE** : This can be adjusted to< br > resolve errors with insufficient history. |
| files | string | false | | File and directory patterns to detect< br > changes using only these list of< br > file(s) (Defaults to the entire repo)< br > **NOTE:** Multiline file/directory patterns should not< br > include quotes. |
| files\_from\_source\_file | string | false | | Source file(s) used to populate the< br > `files` input. |
| files\_ignore | string | false | | Ignore changes to these file(s) **NOTE:** < br > Multiline file/directory patterns should not include< br > quotes. |
| files\_ignore\_from\_source\_file | string | false | | Source file(s) used to populate the< br > `files_ignore` input |
| files\_ignore\_separator | string | false | `"\n"` | Separator used to split the `files_ignore` < br > input |
| files\_separator | string | false | `"\n"` | Separator used to split the `files` < br > input |
| include\_all\_old\_new\_renamed\_files | string | false | `"false"` | Include `all_old_new_renamed_files` output. Note this can< br > generate a large output See: [#501 ](https://github.com/tj-actions/changed-files/issues/501 ). |
| json | string | false | `"false"` | Output list of changed files in< br > a JSON formatted string which can< br > be used for matrix jobs. |
2023-01-03 07:40:10 +00:00
| json\_raw\_format | string | false | `"false"` | Output list of changed files in< br > [jq ](https://devdocs.io/jq/ ) raw output format which means that the output will not be< br > surrounded by quotes and special characters< br > will not be escaped. |
2022-12-31 03:59:38 +00:00
| match\_directories | string | false | `"true"` | Indicates whether to include match directories |
2022-12-30 09:34:56 +00:00
| old\_new\_files\_separator | string | false | `" "` | Split character for old and new< br > renamed filename pairs. |
| old\_new\_separator | string | false | `","` | Split character for old and new< br > filename pairs. |
| output\_dir | string | false | `".github/outputs"` | Directory to store output files. |
| path | string | false | `"."` | Specify a relative path under `$GITHUB_WORKSPACE` < br > to locate the repository. |
2022-12-31 03:59:38 +00:00
| quotepath | string | false | `"true"` | Use non ascii characters to match< br > files and output the filenames completely< br > verbatim by setting this to `false` |
2022-12-30 09:34:56 +00:00
| separator | string | false | `" "` | Split character for output strings |
| sha | string | false | | Specify a different commit SHA used< br > for comparing changes |
| since | string | false | | Get changed files for commits whose< br > timestamp is older than the given< br > time. |
2023-01-10 19:55:11 +00:00
| since\_last\_remote\_commit | string | false | `"false"` | Use the last commit on the< br > remote branch as the `base_sha` . Defaults< br > to the last non merge commit< br > on the target branch for pull< br > request events and the previous remote< br > commit of the current branch for< br > push events. |
2022-12-30 09:34:56 +00:00
| until | string | false | | Get changed files for commits whose< br > timestamp is earlier than the given< br > time. |
| write\_output\_files | string | false | `"false"` | Write outputs to files in the< br > `.github/outputs` folder by default. |
2022-10-29 21:48:36 +00:00
<!-- AUTO - DOC - INPUT:END -->
2022-10-12 19:36:43 +00:00
2022-05-31 02:52:32 +00:00
## Examples
2021-04-04 13:11:55 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files in the current branch< / summary >
2021-03-14 19:42:54 +00:00
```yaml
...
2022-10-18 23:52:27 +00:00
- name: Get changed files
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-05-07 21:46:34 +00:00
2022-10-18 23:52:27 +00:00
< details >
2022-10-18 23:59:54 +00:00
< summary > Get all changed files and using a comma separator< / summary >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get all changed files and use a comma separator in the output
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
separator: ","
...
```
2021-05-01 16:17:17 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-05-01 16:17:17 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files and list all added files< / summary >
2021-04-02 12:08:05 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-12-30 05:27:08 +00:00
2022-10-18 23:52:27 +00:00
- name: List all added files
run: |
for file in ${{ steps.changed-files.outputs.added_files }}; do
echo "$file was added"
done
...
```
2021-05-01 16:17:17 +00:00
2022-10-18 23:52:27 +00:00
See [outputs ](#outputs ) for a list of all available outputs.
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files and optionally run a step if a file was modified< / summary >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-31 04:15:32 +00:00
2022-10-18 23:52:27 +00:00
- name: Run a step if my-file.txt was modified
if: contains(steps.changed-files.outputs.modified_files, 'my-file.txt')
run: |
echo "my-file.txt file has been modified."
...
```
2021-09-05 12:22:47 +00:00
2022-10-18 23:52:27 +00:00
See [outputs ](#outputs ) for a list of all available outputs.
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-09-05 12:22:47 +00:00
2023-03-13 18:06:26 +00:00
< details >
< summary > Get all changed files and write the outputs to a json file< / summary >
```yaml
...
- name: Get changed files and write the outputs to a json file
id: changed-files-write-output-files-json
uses: ./
with:
json: true
write_output_files: true
- name: Verify the contents of the .github/added_files.json file
run: |
cat .github/added_files.json
...
```
See [action.yml ](action.yml#L264 ) for a list of all available keys.
< / details >
< details >
< summary > Get all changed files and write the outputs to a txt file< / summary >
```yaml
...
- name: Get changed files and write the outputs to a txt file
id: changed-files-write-output-files-txt
uses: ./
with:
write_output_files: true
- name: Verify the contents of the .github/added_files.txt file
run: |
cat .github/added_files.txt
...
```
See [action.yml ](action.yml#L264 ) for a list of all available keys.
< / details >
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files using a list of files< / summary >
2021-08-28 01:53:03 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
files: |
my-file.txt
*.sh
*.png
!*.md
test_directory
** /*.sql
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
2021-09-06 15:09:47 +00:00
2022-10-18 23:52:27 +00:00
< / details >
2021-10-30 20:04:52 +00:00
2022-10-18 23:52:27 +00:00
< details >
2023-01-06 17:58:28 +00:00
< summary > Get all changed files using a list of files and take action based on the changes< / summary >
2022-10-18 23:52:27 +00:00
```yaml
...
- name: Get changed files
2023-01-05 19:24:02 +00:00
id: changed-files-specific
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
files: |
my-file.txt
*.sh
*.png
!*.md
test_directory
** /*.sql
- 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: 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."
- name: Run step if any of the listed files above is deleted
2023-01-05 19:24:02 +00:00
if: steps.changed-files-specific.outputs.any_deleted == 'true'
2022-10-18 23:52:27 +00:00
run: |
2023-01-05 19:24:02 +00:00
for file in ${{ steps.changed-files-specific.outputs.deleted_files }}; do
2022-10-18 23:52:27 +00:00
echo "$file was deleted"
done
- name: Run step if all listed files above have been deleted
2023-01-05 19:24:02 +00:00
if: steps.changed-files-specific.outputs.only_deleted == 'true'
2022-10-18 23:52:27 +00:00
run: |
2023-01-05 19:24:02 +00:00
for file in ${{ steps.changed-files-specific.outputs.deleted_files }}; do
2022-10-18 23:52:27 +00:00
echo "$file was deleted"
done
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
See [outputs ](#outputs ) for a list of all available outputs.
< / details >
< details >
< summary > Get all changed files using a source file or list of file(s) to populate to files input< / summary >
```yaml
...
- name: Get changed files using a source file or list of file(s) to populate to files input.
id: changed-files-specific-source-file
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
2022-11-17 19:33:38 +00:00
files_from_source_file: test/changed-files-list.txt
2022-10-18 23:52:27 +00:00
...
```
See [inputs ](#inputs ) for more information.
< / details >
2022-10-12 18:51:58 +00:00
2022-10-18 23:52:27 +00:00
< details >
< summary > Get changed files using a source file or list of file(s) to populate to files input and optionally specify more files< / summary >
```yaml
...
- name: Get changed files using 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
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
files_from_source_file: |
test/changed-files-list.txt
files: |
test.txt
...
```
2022-10-12 18:51:58 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files using a different SHA< / summary >
```yaml
...
- name: Get changed files using a different SHA
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
sha: ${{ github.event.pull_request.head.sha }}
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files using a different base SHA< / summary >
```yaml
...
- name: Get changed files using a different base SHA
id: changed-files
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
base_sha: ${{ github.event.pull_request.base.sha }}
...
```
See [inputs ](#inputs ) for more information.
< / details >
2023-01-19 02:02:19 +00:00
< details >
< summary > Get all changed files between the previous tag and the current tag< / summary >
```yaml
...
on:
push:
tags:
- 'v*'
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
2023-01-19 15:58:09 +00:00
uses: actions/checkout@v3
2023-01-19 02:02:19 +00:00
with:
fetch-depth: 0
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v35
- name: Get changed files in the .github folder
id: changed-files-specific
uses: tj-actions/changed-files@v35
with:
base_sha: ${{ steps.get-base-sha.outputs.base_sha }}
files: .github/**
- name: Run step if any file(s) in the .github folder change
if: steps.changed-files-specific.outputs.any_changed == 'true'
run: |
echo "One or more files in the .github folder has changed."
echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}"
...
```
See [inputs ](#inputs ) for more information.
< / details >
2022-10-18 23:52:27 +00:00
< details >
< summary > Get all changed files for a repository located in a different path< / summary >
```yaml
...
- name: Checkout into dir1
uses: actions/checkout@v3
with:
fetch-depth: 0
path: dir1
- name: Run changed-files with defaults in dir1
id: changed-files-for-dir1
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
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
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files with non äšćįí characters i.e (Filename in other languages)< / summary >
```yaml
...
- name: Run changed-files with quotepath disabled
id: changed-files-quotepath
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
quotepath: "false"
- name: Run changed-files with quotepath disabled for a specified list of file(s)
id: changed-files-quotepath-specific
uses: ./
with:
files: test/test-è.txt
quotepath: "false"
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files using the last successful commit of the base branch< / summary >
< ul >
< li >
< details >
< summary > Push event< / summary >
```yaml
...
2022-05-31 02:46:18 +00:00
- name: Get branch name
id: branch-name
2022-09-25 03:20:05 +00:00
uses: tj-actions/branch-names@v6
2022-05-31 02:46:18 +00:00
2022-11-23 22:02:10 +00:00
- uses: nrwl/nx-set-shas@v3
2022-05-31 02:46:18 +00:00
id: last_successful_commit_push
with:
2022-12-30 05:27:08 +00:00
main-branch-name: ${{ steps.branch-name.outputs.current_branch }} # Get the last successful commit for the current branch.
2022-11-23 22:02:10 +00:00
workflow-id: 'test.yml'
2022-05-31 02:46:18 +00:00
- name: Run changed-files with the commit of the last successful test workflow run
id: changed-files-base-sha-push
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-05-31 02:46:18 +00:00
with:
2022-11-23 22:02:10 +00:00
base_sha: ${{ steps.last_successful_commit_push.outputs.base }}
2022-10-18 23:52:27 +00:00
...
```
2022-10-19 00:08:53 +00:00
2022-10-18 23:52:27 +00:00
< / details >
< / li >
< li >
< details >
< summary > Pull request events < / summary >
2022-05-31 02:46:18 +00:00
2022-10-18 23:52:27 +00:00
```yaml
...
2022-05-31 02:46:18 +00:00
- name: Get branch name
id: branch-name
uses: tj-actions/branch-names@v5
2022-11-23 22:02:10 +00:00
- uses: nrwl/nx-set-shas@v3
2022-05-31 02:46:18 +00:00
id: last_successful_commit_pull_request
with:
2022-12-30 05:27:08 +00:00
main-branch-name: ${{ steps.branch-name.outputs.base_ref_branch }} # Get the last successful commit on master or main branch
2022-05-31 02:46:18 +00:00
workflow_id: 'test.yml'
- name: Run changed-files with the commit of the last successful test workflow run on main
id: changed-files-base-sha-pull-request
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-05-31 02:46:18 +00:00
with:
2022-11-23 22:02:10 +00:00
base_sha: ${{ steps.last_successful_commit_pull_request.outputs.base }}
2022-10-18 23:52:27 +00:00
...
```
2021-10-30 20:04:52 +00:00
2022-10-18 23:52:27 +00:00
< / details >
< / li >
< / ul >
2022-10-13 17:10:10 +00:00
2022-10-18 23:52:27 +00:00
> NOTE: This setting overrides the commit sha used by setting `since_last_remote_commit` to true.
> It is recommended to use either solution that works for your use case.
2022-08-21 02:41:36 +00:00
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
2022-08-21 02:41:36 +00:00
2022-10-18 23:52:27 +00:00
< / details >
< details >
< summary > Get all changed files but only return the directory names< / summary >
```yaml
...
- name: Run changed-files with dir_names
id: changed-files-dir-names
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
dir_names: "true"
...
2021-03-14 19:42:54 +00:00
```
2022-10-18 23:52:27 +00:00
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files and return JSON formatted outputs< / summary >
```yaml
...
- name: Run changed-files with json output
id: changed-files-json
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
json: "true"
...
```
See [inputs ](#inputs ) for more information.
< / details >
< details >
< summary > Get all changed files by commits pushed in the past< / summary >
```yaml
...
- name: Get changed-files since 2022-08-19
id: changed-files-since
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
since: "2022-08-19"
2022-10-31 04:15:32 +00:00
2022-10-18 23:52:27 +00:00
- name: Get changed-files until 2022-08-20
id: changed-files-until
2022-12-19 06:06:50 +00:00
uses: tj-actions/changed-files@v35
2022-10-18 23:52:27 +00:00
with:
until: "2022-08-20"
...
```
See [inputs ](#inputs ) for more information.
< / details >
### Real world example
2021-11-19 22:00:55 +00:00
< img width = "1147" alt = "Screen Shot 2021-11-19 at 4 59 21 PM" src = "https://user-images.githubusercontent.com/17484350/142696936-8b7ca955-7ef9-4d53-9bdf-3e0008e90c3f.png" >
2021-07-06 18:51:18 +00:00
2021-06-09 15:55:30 +00:00
* Free software: [MIT license ](LICENSE )
2021-03-05 02:36:52 +00:00
2021-10-23 13:41:29 +00:00
## Known Limitation
2021-10-23 15:38:14 +00:00
> NOTE: :warning:
2021-10-23 16:03:11 +00:00
>
2022-06-12 14:08:13 +00:00
> * Using characters like `\n`, `%`, `.` and `\r` as separators would be [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp)
2022-02-12 22:08:47 +00:00
> * Spaces in file names can introduce bugs when using bash loops. See: [#216](https://github.com/tj-actions/changed-files/issues/216)
2022-04-13 06:51:04 +00:00
> However, this action will handle spaces in file names, with a recommendation of using a separator to prevent hidden issues.
2021-10-23 16:03:11 +00:00
> 
2021-10-23 13:41:29 +00:00
2022-12-12 23:20:59 +00:00
## Migration guide
With the switch from using grep's Extended regex to match files to the natively supported workflow glob pattern matching syntax introduced in [v13 ](https://github.com/tj-actions/changed-files/releases/tag/v13 ) you'll need to modify patterns used to match `files` .
**BEFORE**
```yml
...
- name: Get specific changed files
id: changed-files-specific
uses: tj-actions/changed-files@v12.2
with:
files: |
\.sh$
.(sql|py)$
^(mynewfile|custom)
```
**AFTER**
```yml
...
- name: Get specific changed files
id: changed-files-specific
uses: tj-actions/changed-files@v24
with:
files: |
*.sh
*.sql
*.py
mynewfile
custom/**
```
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 ).
2022-01-10 20:05:01 +00:00
* [tj-actions/glob ](https://github.com/tj-actions/glob )
2022-12-16 14:27:46 +00:00
* [tj-actions/auto-doc ](https://github.com/tj-actions/auto-doc )
2022-12-16 14:45:25 +00:00
* [tj-actions/verify-changed-files ](https://github.com/tj-actions/verify-changed-files )
2022-06-07 14:43:44 +00:00
* [tj-actions/demo ](https://github.com/tj-actions/demo )
2022-10-31 01:17:22 +00:00
* [tj-actions/demo2 ](https://github.com/tj-actions/demo2 )
2022-11-07 14:11:40 +00:00
* [tj-actions/demo3 ](https://github.com/tj-actions/demo3 )
2022-10-02 12:35:22 +00:00
* [tj-actions/release-tagger ](https://github.com/tj-actions/release-tagger )
2022-01-10 19:42:33 +00:00
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.
2022-11-08 20:24:38 +00:00
* Any details about your workflow that might be helpful in troubleshooting. (**NOTE**: Ensure that you include full log outputs with debugging enabled)
2021-06-09 15:55:30 +00:00
* 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 -->
2023-01-05 18:00:54 +00:00
2021-06-09 23:07:22 +00:00
<!-- prettier - ignore - start -->
2023-01-05 18:00:54 +00:00
2021-06-09 23:07:22 +00:00
<!-- markdownlint - disable -->
2023-01-05 18:00:54 +00:00
2021-06-09 23:07:22 +00:00
< table >
2022-10-05 16:14:01 +00:00
< tbody >
< 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 = "Josh Soref" / > < 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 >
< td align = "center" > < a href = "https://github.com/monoxgas" > < img src = "https://avatars.githubusercontent.com/u/1223016?v=4?s=100" width = "100px;" alt = "Nick Landers" / > < 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 >
< td align = "center" > < a href = "https://github.com/Kras4ooo" > < img src = "https://avatars.githubusercontent.com/u/1948054?v=4?s=100" width = "100px;" alt = "Krasimir Nikolov" / > < 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 >
< td align = "center" > < a href = "https://github.com/IvanPizhenko" > < img src = "https://avatars.githubusercontent.com/u/11859904?v=4?s=100" width = "100px;" alt = "Ivan Pizhenko" / > < 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 >
< td align = "center" > < a href = "https://github.com/talva-tr" > < img src = "https://avatars.githubusercontent.com/u/82046981?v=4?s=100" width = "100px;" alt = "talva-tr" / > < br / > < sub > < b > talva-tr< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=talva-tr" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://bandism.net/" > < img src = "https://avatars.githubusercontent.com/u/22633385?v=4?s=100" width = "100px;" alt = "Ikko Ashimine" / > < br / > < sub > < b > Ikko Ashimine< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=eltociear" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/Zamiell" > < img src = "https://avatars.githubusercontent.com/u/5511220?v=4?s=100" width = "100px;" alt = "James" / > < br / > < sub > < b > James< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=Zamiell" title = "Documentation" > 📖< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "https://github.com/wushujames" > < img src = "https://avatars.githubusercontent.com/u/677529?v=4?s=100" width = "100px;" alt = "James Cheng" / > < br / > < sub > < b > James Cheng< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=wushujames" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://qiita.com/SUZUKI_Masaya" > < img src = "https://avatars.githubusercontent.com/u/15100604?v=4?s=100" width = "100px;" alt = "Masaya Suzuki" / > < br / > < sub > < b > Masaya Suzuki< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=massongit" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://fagai.net" > < img src = "https://avatars.githubusercontent.com/u/1772112?v=4?s=100" width = "100px;" alt = "fagai" / > < br / > < sub > < b > fagai< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=fagai" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/pkit" > < img src = "https://avatars.githubusercontent.com/u/805654?v=4?s=100" width = "100px;" alt = "Constantine Peresypkin" / > < br / > < sub > < b > Constantine Peresypkin< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=pkit" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/deronnax" > < img src = "https://avatars.githubusercontent.com/u/439279?v=4?s=100" width = "100px;" alt = "Mathieu Dupuy" / > < br / > < sub > < b > Mathieu Dupuy< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=deronnax" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/JoeOvo" > < img src = "https://avatars.githubusercontent.com/u/100686542?v=4?s=100" width = "100px;" alt = "Joe Moggridge" / > < br / > < sub > < b > Joe Moggridge< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=JoeOvo" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://www.credly.com/users/thyarles/badges" > < img src = "https://avatars.githubusercontent.com/u/1340046?v=4?s=100" width = "100px;" alt = "Charles Santos" / > < br / > < sub > < b > Charles Santos< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=thyarles" title = "Code" > 💻< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "https://github.com/kostiantyn-korniienko-aurea" > < img src = "https://avatars.githubusercontent.com/u/37180625?v=4?s=100" width = "100px;" alt = "Kostiantyn Korniienko" / > < br / > < sub > < b > Kostiantyn Korniienko< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=kostiantyn-korniienko-aurea" title = "Documentation" > 📖< / a > < / td >
2022-10-12 20:16:07 +00:00
< td align = "center" > < a href = "https://github.com/lpulley" > < img src = "https://avatars.githubusercontent.com/u/7193187?v=4?s=100" width = "100px;" alt = "Logan Pulley" / > < br / > < sub > < b > Logan Pulley< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=lpulley" title = "Code" > 💻< / a > < / td >
2022-11-06 15:51:44 +00:00
< td align = "center" > < a href = "https://www.linkedin.com/in/kenji-miyake/" > < img src = "https://avatars.githubusercontent.com/u/31987104?v=4?s=100" width = "100px;" alt = "Kenji Miyake" / > < br / > < sub > < b > Kenji Miyake< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=kenji-miyake" title = "Code" > 💻< / a > < / td >
2022-12-30 05:26:57 +00:00
< td align = "center" > < a href = "https://github.com/adonisgarciac" > < img src = "https://avatars.githubusercontent.com/u/71078987?v=4?s=100" width = "100px;" alt = "adonisgarciac" / > < br / > < sub > < b > adonisgarciac< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=adonisgarciac" title = "Code" > 💻< / a > < a href = "https://github.com/tj-actions/changed-files/commits?author=adonisgarciac" title = "Documentation" > 📖< / a > < / td >
2023-01-05 17:58:53 +00:00
< td align = "center" > < a href = "https://github.com/cfernhout" > < img src = "https://avatars.githubusercontent.com/u/22294606?v=4?s=100" width = "100px;" alt = "Chiel Fernhout" / > < br / > < sub > < b > Chiel Fernhout< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=cfernhout" title = "Documentation" > 📖< / a > < / td >
2022-10-05 16:14:01 +00:00
< / tr >
< / tbody >
2021-06-09 23:07:22 +00:00
< / table >
<!-- markdownlint - restore -->
2023-01-05 18:00:54 +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!
