|
|
|
|
@@ -1,8 +1,12 @@
|
|
|
|
|
[](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)
|
|
|
|
|
[](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)
|
|
|
|
|
|
|
|
|
|
[](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)
|
|
|
|
|
|
|
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
|
|
|
|
|
|
|
|
[](#contributors-)
|
|
|
|
|
[](#contributors-)
|
|
|
|
|
|
|
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
|
|
|
|
|
|
|
|
@@ -12,6 +16,7 @@ Retrieve all changed files relative to the default branch (`pull_request*` based
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
* Fast execution.
|
|
|
|
|
* Easy to debug.
|
|
|
|
|
* Boolean output indicating that certain files have been modified.
|
|
|
|
|
* Multiple repository support.
|
|
|
|
|
@@ -22,12 +27,6 @@ Retrieve all changed files relative to the default branch (`pull_request*` based
|
|
|
|
|
* Report on files that have at least one change.
|
|
|
|
|
* [Regex pattern](https://www.gnu.org/software/grep/manual/grep.html#Regular-Expressions) matching on a subset of files.
|
|
|
|
|
|
|
|
|
|
## Supported Platforms
|
|
|
|
|
|
|
|
|
|
* [`ubuntu-*`](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
|
|
|
|
|
* [`macos-*`](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
|
|
|
|
|
* [`windows-*`](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
> NOTE: :warning:
|
|
|
|
|
@@ -57,7 +56,7 @@ jobs:
|
|
|
|
|
|
|
|
|
|
- name: Get changed files
|
|
|
|
|
id: changed-files
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
|
|
|
|
|
- name: List all modified files
|
|
|
|
|
run: |
|
|
|
|
|
@@ -81,32 +80,33 @@ jobs:
|
|
|
|
|
|
|
|
|
|
| Output | type | example | description |
|
|
|
|
|
|:--------------------:|:------------:|:----------------------------------:|:----------------------------------------:|
|
|
|
|
|
| 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. |
|
|
|
|
|
| any_deleted | `string` | `true` OR `false` | Returns `true` when any <br /> of the filenames provided using <br /> the `files` input has been deleted. |
|
|
|
|
|
| only_deleted | `string` | `true` OR `false` | Returns `true` when only <br /> files provided using <br /> the `files` input has been deleted. |
|
|
|
|
|
| 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).* |
|
|
|
|
|
| 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) |
|
|
|
|
|
| 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) |
|
|
|
|
|
|
|
|
|
|
## Inputs
|
|
|
|
|
|
|
|
|
|
| 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) |
|
|
|
|
|
| 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` | `true` | `' '` | Output string separator |
|
|
|
|
|
| files | `string` OR `string[]` | `false` | | Check for changes <br> using only these <br> list of file(s) <br> (Defaults to the <br> entire repo) |
|
|
|
|
|
| base_sha | `string` | `false` | | Specify a different <br> base 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 |
|
|
|
|
|
| sha | `string` | `true` | `${{ github.sha }}` | Specify a different <br> commit SHA <br> used for <br> comparing changes |
|
|
|
|
|
| files_from_source_file | `string` | `false` | | Source file <br> used to populate <br> the files input |
|
|
|
|
|
| files\_from\_source\_file | `string` | `false` | | Source file <br> used to populate <br> the files input |
|
|
|
|
|
| path | `string` | `false` | | Relative path under <br> `GITHUB_WORKSPACE` <br> to the repository |
|
|
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
@@ -118,11 +118,11 @@ jobs:
|
|
|
|
|
|
|
|
|
|
- name: Get changed files using defaults
|
|
|
|
|
id: changed-files
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
|
|
|
|
|
- name: Get changed files using a comma separator
|
|
|
|
|
id: changed-files-comma
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
with:
|
|
|
|
|
separator: ","
|
|
|
|
|
|
|
|
|
|
@@ -144,7 +144,7 @@ jobs:
|
|
|
|
|
|
|
|
|
|
- name: Get specific changed files
|
|
|
|
|
id: changed-files-specific
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
with:
|
|
|
|
|
files: |
|
|
|
|
|
my-file.txt
|
|
|
|
|
@@ -182,14 +182,14 @@ jobs:
|
|
|
|
|
|
|
|
|
|
- name: Use a source file or list of file(s) to populate to files input.
|
|
|
|
|
id: changed-files-specific-source-file
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
with:
|
|
|
|
|
files_from_source_file: |
|
|
|
|
|
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
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
with:
|
|
|
|
|
files_from_source_file: |
|
|
|
|
|
test/changed-files-list.txt
|
|
|
|
|
@@ -198,13 +198,13 @@ jobs:
|
|
|
|
|
|
|
|
|
|
- name: Use a different commit SHA
|
|
|
|
|
id: changed-files-custom-sha
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
with:
|
|
|
|
|
sha: ${{ github.event.pull_request.head.sha }}
|
|
|
|
|
|
|
|
|
|
- name: Use a different base SHA
|
|
|
|
|
id: changed-files-custom-base-sha
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
with:
|
|
|
|
|
base_sha: "2096ed0"
|
|
|
|
|
|
|
|
|
|
@@ -212,13 +212,19 @@ jobs:
|
|
|
|
|
uses: actions/checkout@v2
|
|
|
|
|
with:
|
|
|
|
|
fetch-depth: 0
|
|
|
|
|
path: subfolder
|
|
|
|
|
path: dir1
|
|
|
|
|
|
|
|
|
|
- name: Run changed-files with defaults on the dir1
|
|
|
|
|
id: changed-files-for-subfolder
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
id: changed-files-for-dir1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
with:
|
|
|
|
|
path: subfolder
|
|
|
|
|
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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Running [pre-commit](https://pre-commit.com/) on all modified files
|
|
|
|
|
@@ -232,7 +238,7 @@ jobs:
|
|
|
|
|
|
|
|
|
|
- name: Get changed files
|
|
|
|
|
id: changed-files
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.1
|
|
|
|
|
uses: tj-actions/changed-files@v1.1.2
|
|
|
|
|
|
|
|
|
|
- name: Pre-commit
|
|
|
|
|
uses: pre-commit/action@v2.0.0
|
|
|
|
|
|
