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-02-01 16:50:04 +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://github.com/search?o=desc\&q=tj-actions+changed-files+language%3AYAML\&s=\&type=Code)
2021-09-19 23:58:07 +00:00
2021-10-30 19:58:02 +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 -->
2022-08-15 02:45:25 +00:00
2022-08-15 02:34:46 +00:00
[](#contributors-)
2022-08-15 02:45:25 +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
2022-08-17 21:46:38 +00:00
Retrieve all changed files and directories relative to the target branch (`pull_request*` based events) or the last remote commit (`push` based event) returning the **absolute path** to all changed files and directories 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
2021-09-29 12:43:54 +00:00
* Fast execution (0-2 seconds on average).
2021-09-20 00:45:52 +00:00
* Easy to debug.
2021-12-14 05:21:49 +00:00
* Boolean output indicating that certain files have been changed.
2022-03-20 17:30:55 +00:00
* Scales to large repositories.
2022-02-26 02:50:07 +00:00
* Git submodules support.
2022-06-11 20:25:18 +00:00
* No extra API calls.
2022-08-07 21:14:00 +00:00
* Escaped JSON Output which can be used for running matrix jobs based on changed files.
2022-08-07 21:13:09 +00:00
* List only changed directories.
2022-05-19 12:03:53 +00:00
* Monorepos (Fetches only the last remote commit).
* 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.
* Between the current pull request branch and the fork point 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:
2021-06-09 15:55:30 +00:00
* Report on files that have at least one change.
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.
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-07-21 22:36:35 +00:00
> * When using `persist-credentials: false` with `actions/checkout@v3` you'll need to specify a `token` using the `token` input.
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).
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:
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.
2021-08-28 01:53:03 +00:00
2021-05-04 17:53:26 +00:00
- name: Get changed files
id: changed-files
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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
```
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
2021-04-24 08:49:18 +00:00
## Outputs
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-05-14 18:54:45 +00:00
| Output | type | example | description |
|:----------------------------------:|:--------:|:--------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
2022-06-29 01:14:35 +00:00
| any\_changed | `string` | `true` OR `false` | Returns `true` when any < br /> of the filenames provided using < br /> the `files` input has changed. If no `files` have been specified,< br > an empty string `''` is returned. < 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 has changed. If no `files` have been specified,< br > an empty string `''` is returned. (ACMR) |
2022-05-14 18:54:45 +00:00
| 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)* |
2022-06-29 01:14:35 +00:00
| any\_modified | `string` | `true` OR `false` | Returns `true` when any < br /> of the filenames provided using < br /> the `files` input has been modified. If no `files` have been specified,< br > an empty string `''` is returned. < br /> i.e. *using a combination of all added, <br />copied, modified, renamed, and deleted files (ACMRD)* |
| only\_modified | `string` | `true` OR `false` | Returns `true` when only < br /> files provided using < br /> the `files` input has been modified. If no `files` have been specified,< br > an empty string `''` is returned.(ACMRD) |
2022-05-14 18:54:45 +00:00
| other\_modified\_files | `string` | `'new.txt path/to/file.png ...'` | Select all other modified files < br /> not listed in the files input < br /> i.e. *a combination of all added, <br /> copied, modified, and deleted files (ACMRD)* |
2022-06-29 01:14:35 +00:00
| any\_deleted | `string` | `true` OR `false` | Returns `true` when any < br /> of the filenames provided using < br /> the `files` input has been deleted. If no `files` have been specified,< br > an empty string `''` is returned. (D) |
| only\_deleted | `string` | `true` OR `false` | Returns `true` when only < br /> files provided using < br /> the `files` input has been deleted. If no `files` have been specified,< br > an empty string `''` is returned. (D) |
2022-05-14 18:54:45 +00:00
| 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\_changed\_files | `string` | `'new.txt path/to/file.png ...'` | Select all changed files < br /> i.e. *a combination of all added, <br />copied, modified and renamed files (ACMR)* |
| all\_modified\_files | `string` | `'new.txt path/to/file.png ...'` | Select all changed files < br /> i.e. *a combination of all added, <br />copied, modified, renamed and deleted files (ACMRD)* |
| 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)* |
2022-07-07 01:36:59 +00:00
| all\_old\_new\_renamed\_files | `string` | `'old name.txt,new name.txt old name 2.txt,new name 2.txt...'` | Select only files that are Renamed and list their old and new names. < br > NOTE: This requires setting `include_all_old_new_renamed_files` to `true` (R) |
2022-05-14 18:54:45 +00:00
| 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
2022-06-12 14:08:13 +00:00
| Input | type | required | default | description |
|:--------------------------------------:|:----------------------:|:--------:|:---------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 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 ) |
| separator | `string` | `false` | `' '` | Split character for output strings |
2022-08-03 20:01:40 +00:00
| include\_all\_old\_new\_renamed\_files | `boolean` | `false` | `false` | Include `all_old_new_renamed_files` output. Note this can generate a large output See: [#501 ](https://github.com/tj-actions/changed-files/issues/501 ). |
2022-06-12 14:08:13 +00:00
| old\_new\_separator | `string` | `false` | `','` | Split character for old and new filename pairs |
| old\_new\_files\_separator | `string` | `false` | `' '` | Split character for multiple old and new filename pairs |
| files | `string` OR `string[]` | `false` | | Check for changes < br > using only these < br > list of file(s) < br > (Defaults to the < br > entire repo) |
| files\_separator | `string` | `false` | `'\n'` | Separator used to split the< br > `files` input |
| files\_from\_source\_file | `string` | `false` | | Source file(s) < br > used to populate < br > the `files` input |
| files\_ignore | `string` | `false` | | Ignore changes to these file(s) |
| files\_ignore\_separator | `string` | `false` | `'\n'` | Separator used to split the < br > `files-ignore` input |
| files\_ignore\_from\_source\_file | `string` | `false` | | Source file(s) < br > used to populate < br > the `files_ignore` input |
| sha | `string` | `true` | `${{ github.sha }}` | Specify a different < br > commit SHA < br > used for < br > comparing changes |
| base\_sha | `string` | `false` | | Specify a different < br > base commit SHA < br > used for < br > comparing changes |
| path | `string` | `false` | `'.'` | Relative path under < br > `GITHUB_WORKSPACE` < br > to the repository |
2022-07-21 22:37:16 +00:00
| since\_last\_remote\_commit | `boolean` | `false` | `false` | Use the last commit on the remote < br > branch as the `base_sha` < br > (Defaults to the last commit < br > on the target branch for Pull requests < br > or the previous commit < br > on the current branch < br > for push events). < br /> NOTE: This requires < br /> `fetch-depth: 0` < br /> with `actions/checkout@v3` |
2022-06-12 14:08:13 +00:00
| use\_fork\_point | `boolean` | `false` | `false` | Finds best common ancestor < br /> between two commits < br /> to use in a three-way merge < br /> as the `base_sha` < br /> See: [git merge-base ](https://git-scm.com/docs/git-merge-base#Documentation/git-merge-base.txt---fork-point ). < br > NOTE: This pulls the entire commit history of the base branch |
| quotepath | `boolean` | `false` | `true` | Output filenames completely verbatim by setting this to `false` |
| diff\_relative | `boolean` | `false` | | Exclude changes outside the current directory and show pathnames relative to it. |
2022-08-03 20:01:40 +00:00
| dir\_names | `boolean` | `false` | `false` | Output unique changed directories instead of filenames. < br > NOTE: This returns `.` for < br > changed files located in the root of the project. |
| json | `boolean` | `false` | `false` | Output changed files in JSON format which can be used for matrix jobs. |
2021-04-24 08:49:18 +00:00
2022-05-31 02:52:32 +00:00
## Examples
2021-04-04 13:11:55 +00:00
2021-03-14 19:42:54 +00:00
```yaml
...
steps:
2022-03-30 03:50:08 +00:00
- uses: actions/checkout@v3
2022-02-24 05:22:23 +00:00
# with:
# fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
# submodules: true # OR "recursive" -> To include all changed submodule files.
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
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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-10-12 13:47:12 +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
2022-01-21 16:19:23 +00:00
if: contains(steps.changed-files.outputs.modified_files, 'my-file.txt')
2021-04-02 12:08:05 +00:00
run: |
2021-10-11 16:31:51 +00:00
echo "Your my-file.txt file 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
2022-01-21 16:19:23 +00:00
if: contains(steps.changed-files.outputs.deleted_files, 'test.txt')
2021-04-02 12:08:05 +00:00
run: |
2021-10-11 16:31:51 +00:00
echo "Your test.txt file has been deleted."
2021-05-01 16:17:17 +00:00
- name: Get specific changed files
id: changed-files-specific
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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
2022-01-05 02:38:03 +00:00
*.sh
*.png
2022-01-05 03:08:06 +00:00
!*.md
2022-01-05 02:38:03 +00:00
*.jpeg
** /migrate-*.sql
2022-02-18 15:41:08 +00:00
files_ignore: |
2022-02-16 08:28:03 +00:00
*.yml
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
2022-01-21 16:19:23 +00:00
if: steps.changed-files-specific.outputs.any_changed == 'true'
2021-07-16 15:29:34 +00:00
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
2022-01-21 16:19:23 +00:00
if: steps.changed-files-specific.outputs.only_changed == 'true'
2021-07-20 19:32:52 +00:00
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
2022-01-21 16:19:23 +00:00
if: steps.changed-files.outputs.any_deleted == 'true'
2021-09-05 12:22:47 +00:00
run: |
2021-10-12 13:47:12 +00:00
for file in ${{ steps.changed-files.outputs.deleted_files }}; do
2021-09-05 12:22:47 +00:00
echo "$file was deleted"
done
- name: Run step if all listed files above have been deleted
2022-01-21 16:19:23 +00:00
if: steps.changed-files.outputs.only_deleted == 'true'
2021-09-05 12:22:47 +00:00
run: |
2021-10-12 13:47:12 +00:00
for file in ${{ steps.changed-files.outputs.deleted_files }}; do
2021-09-05 12:22:47 +00:00
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
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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: |
2021-09-29 16:15:56 +00:00
test.txt
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
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2021-07-17 15:52:34 +00:00
with:
base_sha: "2096ed0"
2021-08-28 02:01:21 +00:00
- name: Checkout into dir1
2022-07-21 22:37:16 +00:00
uses: actions/checkout@v3
2021-08-28 02:01:21 +00:00
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
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
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: |
2021-10-12 13:47:12 +00:00
for file in ${{ steps.changed-files-for-dir1.outputs.added_files }}; do
2021-09-06 15:09:47 +00:00
echo "$file was added"
done
2021-10-30 20:04:52 +00:00
2021-10-30 20:23:17 +00:00
- name: Run changed-files using the last commit on the remote branch
2021-10-30 20:04:52 +00:00
id: changed-files-since-last-remote-commit
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2021-10-30 20:04:52 +00:00
with:
2021-12-30 01:44:54 +00:00
since_last_remote_commit: "true"
2022-02-18 04:32:26 +00:00
- name: Run changed-files using the fork point of a pull request
id: changed-files-fork-point
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2022-02-18 04:32:26 +00:00
with:
use_fork_point: "true"
2022-04-28 06:30:50 +00:00
- name: Run changed-files with quotepath disabled
id: changed-files-quotepath
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2022-04-28 06:30:50 +00:00
with:
quotepath: "false"
2022-05-31 02:46:18 +00:00
# Run changed-files action using the last successful commit as the base_sha
# NOTE: This setting overrides the commit sha used by setting since_last_remote_commit to true.
2022-06-13 12:57:36 +00:00
# It is recommended to use either solution that works for your use case.
2022-05-31 02:46:18 +00:00
# Push event based workflows
- name: Get branch name
id: branch-name
uses: tj-actions/branch-names@v5
- uses: nrwl/last-successful-commit-action@v1
id: last_successful_commit_push
with:
branch: ${{ steps.branch-name.outputs.current_branch }} # Get the last successful commit for the current branch.
workflow_id: 'test.yml'
github_token: ${{ secrets.GITHUB_TOKEN }}
- name: Run changed-files with the commit of the last successful test workflow run
id: changed-files-base-sha-push
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2022-05-31 02:46:18 +00:00
with:
base_sha: ${{ steps.last_successful_commit_push.outputs.commit_hash }}
# Pull request based workflows.
- name: Get branch name
id: branch-name
uses: tj-actions/branch-names@v5
if: github.event_name == 'pull_request'
- uses: nrwl/last-successful-commit-action@v1
id: last_successful_commit_pull_request
if: github.event_name == 'pull_request'
with:
branch: ${{ steps.branch-name.outputs.base_ref_branch }} # Get the last successful commit on master or main branch
workflow_id: 'test.yml'
github_token: ${{ secrets.GITHUB_TOKEN }}
- name: Run changed-files with the commit of the last successful test workflow run on main
if: github.event_name == 'pull_request'
id: changed-files-base-sha-pull-request
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2022-05-31 02:46:18 +00:00
with:
base_sha: ${{ steps.last_successful_commit_pull_request.outputs.commit_hash }}
2021-10-30 20:04:52 +00:00
2022-06-12 14:10:32 +00:00
- name: Run changed-files with dir_names
id: changed-files-dir-names
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2022-06-12 14:10:32 +00:00
with:
dir_names: "true"
2022-08-03 20:01:40 +00:00
# All outputs are JSON formatted arrays and can be used in other actions and matrix compatible jobs.
- name: Run changed-files with json output
id: changed-files-json
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2022-08-03 20:01:40 +00:00
with:
json: "true"
2021-03-14 19:42:54 +00:00
```
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-02-17 05:02:24 +00:00
## Versioning
This project follows a `v(major).(patch)` versioning scheme with the exception of pointing the git ref of the latest patch release to the major version tag.
> NOTE: :warning:
2022-02-17 05:03:22 +00:00
>
2022-08-12 03:59:16 +00:00
> * Users referencing the legacy `v1.x.x` → `v5.0.0` semantic versions, are required to switch over to `v10.x` → `v15.x` respectively as new releases would no longer be deployed using the old versioning scheme.
2022-02-17 05:02:24 +00:00
> * A breaking change was introduced in `v1.1.4` and `v13.x` which has been fixed.
2022-03-22 06:02:50 +00:00
## Migration guide
2022-03-22 06:34:14 +00:00
2022-06-13 12:57:36 +00:00
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` .
2022-03-22 06:02:50 +00:00
**BEFORE**
2022-03-22 06:34:14 +00:00
2022-03-22 06:02:50 +00:00
```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**
2022-03-22 06:34:14 +00:00
2022-03-22 06:02:50 +00:00
```yml
...
- name: Get specific changed files
id: changed-files-specific
2022-08-17 21:52:35 +00:00
uses: tj-actions/changed-files@v27
2022-03-22 06:02:50 +00:00
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-06-07 14:43:44 +00:00
* [tj-actions/demo ](https://github.com/tj-actions/demo )
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.
* 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 -->
2022-08-15 02:45:25 +00:00
2021-06-09 23:07:22 +00:00
<!-- prettier - ignore - start -->
2022-08-15 02:45:25 +00:00
2021-06-09 23:07:22 +00:00
<!-- markdownlint - disable -->
2022-08-15 02:45:25 +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-10-12 11:59:10 +00:00
< 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 = "" / > < 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 >
2021-10-17 17:15:06 +00:00
< td align = "center" > < a href = "https://bandism.net/" > < img src = "https://avatars.githubusercontent.com/u/22633385?v=4?s=100" width = "100px;" alt = "" / > < 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 >
2022-01-07 19:31:32 +00:00
< td align = "center" > < a href = "https://github.com/Zamiell" > < img src = "https://avatars.githubusercontent.com/u/5511220?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > James< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=Zamiell" title = "Documentation" > 📖< / a > < / td >
2021-06-09 23:07:22 +00:00
< / tr >
2022-01-21 16:20:50 +00:00
< 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 = "" / > < 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 >
2022-01-25 01:51:13 +00:00
< 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 = "" / > < 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 >
2022-02-18 15:41:52 +00:00
< td align = "center" > < a href = "https://fagai.net" > < img src = "https://avatars.githubusercontent.com/u/1772112?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > fagai< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/changed-files/commits?author=fagai" title = "Documentation" > 📖< / a > < / td >
2022-02-22 23:26:37 +00:00
< td align = "center" > < a href = "https://github.com/pkit" > < img src = "https://avatars.githubusercontent.com/u/805654?v=4?s=100" width = "100px;" alt = "" / > < 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 >
2022-06-13 12:58:37 +00:00
< td align = "center" > < a href = "https://github.com/deronnax" > < img src = "https://avatars.githubusercontent.com/u/439279?v=4?s=100" width = "100px;" alt = "" / > < 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 >
2022-06-28 17:37:33 +00:00
< td align = "center" > < a href = "https://github.com/JoeOvo" > < img src = "https://avatars.githubusercontent.com/u/100686542?v=4?s=100" width = "100px;" alt = "" / > < 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 >
2022-08-15 02:34:46 +00:00
< 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 = "" / > < 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 >
2022-01-21 16:20:50 +00:00
< / tr >
2021-06-09 23:07:22 +00:00
< / table >
<!-- markdownlint - restore -->
2022-08-15 02:45:25 +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!
