actions/changed-files
3
0
Fork 0
mirror of https://github.com/tj-actions/changed-files synced 2025-01-29 13:34:51 +00:00
Code Issues Activity

Updated README.md (#1125)

Browse source 
Co-authored-by: repo-ranger[bot] <repo-ranger[bot]@users.noreply.github.com>
This commit is contained in:
Tonye Jack 2023-05-12 15:54:19 -06:00 committed by GitHub
parent 8873eb78c3
commit 32778a6046
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 52 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
README.md
View file

@ -168,29 +168,29 @@ Support this project with a :star:
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
| OUTPUT | TYPE | DESCRIPTION |
|--------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| added\_files | string | Returns only files that are<br>Added (A). |
| all\_changed\_and\_modified\_files | string | Returns all changed and modified<br> files i.e. *a combination of<br>(ACMRDTUX)* |
| all\_changed\_files | string | Returns all changed files i.e.<br> *a combination of all added,<br> copied, modified and renamed files<br>(ACMR)* |
| all\_modified\_files | string | Returns all changed files i.e.<br> *a combination of all added,<br> copied, modified, renamed and deleted<br>files (ACMRD)*. |
| all\_old\_new\_renamed\_files | string | Returns only files that are<br> Renamed and list their old<br> and new names. **NOTE:** This<br> requires setting `include_all_old_new_renamed_files` to `true`<br>(R) |
| any\_changed | string | Returns `true` when any of<br> the filenames provided using the<br> `files` input has changed. If<br> no `files` have been specified,an<br> empty string `''` is returned.<br> i.e. *using a combination of<br> all added, copied, modified and<br>renamed files (ACMR)*. |
| any\_deleted | string | Returns `true` when any of<br> the filenames provided using the<br> `files` input has been deleted.<br> If no `files` have been<br> specified,an empty string `''` is<br>returned. (D) |
| any\_modified | string | Returns `true` when any of<br> the filenames provided using the<br> `files` input has been modified.<br> If no `files` have been<br> specified,an empty string `''` is<br> returned. i.e. *using a combination<br> of all added, copied, modified,<br>renamed, and deleted files (ACMRD)*. |
| copied\_files | string | Returns only files that are<br>Copied (C). |
| deleted\_files | string | Returns only files that are<br>Deleted (D). |
| modified\_files | string | Returns only files that are<br>Modified (M). |
| only\_changed | string | Returns `true` when only files<br> provided using the `files` input<br> has changed. If no `files`<br> have been specified,an empty string<br> `''` is returned. i.e. *using<br> a combination of all added,<br> copied, modified and renamed files<br>(ACMR)*. |
| only\_deleted | string | Returns `true` when only files<br> provided using the `files` input<br> has been deleted. If no<br> `files` have been specified,an empty<br>string `''` is returned. (D) |
| only\_modified | string | Returns `true` when only files<br> provided using the `files` input<br> has been modified. If no<br> `files` have been specified,an empty<br>string `''` is returned.(ACMRD). |
| other\_changed\_files | string | Returns all other changed files<br> not listed in the files<br> input i.e. *using a combination<br> of all added, copied, modified<br>and renamed files (ACMR)*. |
| other\_deleted\_files | string | Returns all other deleted files<br> not listed in the files<br> input i.e. *a combination of<br>all deleted files (D)* |
| other\_modified\_files | string | Returns all other modified files<br> not listed in the files<br> input i.e. *a combination of<br> all added, copied, modified, and<br>deleted files (ACMRD)* |
| renamed\_files | string | Returns only files that are<br>Renamed (R). |
| type\_changed\_files | string | Returns only files that have<br>their file type changed (T). |
| unknown\_files | string | Returns only files that are<br>Unknown (X). |
| unmerged\_files | string | Returns only files that are<br>Unmerged (U). |
| OUTPUT | TYPE | DESCRIPTION |
|--------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| added\_files | string | Returns only files that are <br>Added (A). |
| all\_changed\_and\_modified\_files | string | Returns all changed and modified <br>files i.e. *a combination of (ACMRDTUX)* |
| all\_changed\_files | string | Returns all changed files i.e. <br>*a combination of all added, copied, modified and renamed files (ACMR)* |
| all\_modified\_files | string | Returns all changed files i.e. <br>*a combination of all added, copied, modified, renamed and deleted files (ACMRD)*. |
| all\_old\_new\_renamed\_files | string | Returns only files that are <br>Renamed and list their old <br>and new names. **NOTE:** This <br>requires setting `include_all_old_new_renamed_files` to `true` <br>(R) |
| any\_changed | string | Returns `true` when any of <br>the filenames provided using the <br>`files` input has changed. If <br>no `files` have been specified,an <br>empty string `''` is returned. <br>i.e. *using a combination of all added, copied, modified and renamed files (ACMR)*. |
| any\_deleted | string | Returns `true` when any of <br>the filenames provided using the <br>`files` input has been deleted. <br>If no `files` have been <br>specified,an empty string `''` is <br>returned. (D) |
| any\_modified | string | Returns `true` when any of <br>the filenames provided using the <br>`files` input has been modified. <br>If no `files` have been <br>specified,an empty string `''` is <br>returned. i.e. *using a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. |
| copied\_files | string | Returns only files that are <br>Copied (C). |
| deleted\_files | string | Returns only files that are <br>Deleted (D). |
| modified\_files | string | Returns only files that are <br>Modified (M). |
| only\_changed | string | Returns `true` when only files <br>provided using the `files` input <br>has changed. If no `files` <br>have been specified,an empty string <br>`''` is returned. i.e. *using a combination of all added, copied, modified and renamed files (ACMR)*. |
| only\_deleted | string | Returns `true` when only files <br>provided using the `files` input <br>has been deleted. If no <br>`files` have been specified,an empty <br>string `''` is returned. (D) |
| only\_modified | string | Returns `true` when only files <br>provided using the `files` input <br>has been modified. If no <br>`files` have been specified,an empty <br>string `''` is returned.(ACMRD). |
| other\_changed\_files | string | Returns all other changed files <br>not listed in the files <br>input i.e. *using a combination of all added, copied, modified and renamed files (ACMR)*. |
| other\_deleted\_files | string | Returns all other deleted files <br>not listed in the files <br>input i.e. *a combination of all deleted files (D)* |
| other\_modified\_files | string | Returns all other modified files <br>not listed in the files <br>input i.e. *a combination of all added, copied, modified, and deleted files (ACMRD)* |
| renamed\_files | string | Returns only files that are <br>Renamed (R). |
| type\_changed\_files | string | Returns only files that have <br>their file type changed (T). |
| unknown\_files | string | Returns only files that are <br>Unknown (X). |
| unmerged\_files | string | Returns only files that are <br>Unmerged (U). |
<!-- AUTO-DOC-OUTPUT:END -->
@ -198,35 +198,35 @@ Support this project with a :star:
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------------------------------|--------|----------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| base\_sha | string | false | | Specify a different base commit<br>SHA used for comparing changes |
| diff\_relative | string | false | | Exclude changes outside the current<br> directory and show path names<br> relative to it. **NOTE:** This<br> requires you to specify the<br> top level directory via the<br>`path` input. |
| dir\_names | string | false | `"false"` | Output unique changed directories instead<br> of filenames. **NOTE:** This returns<br> `.` for changed files located<br> in the root of the<br>project. |
| dir\_names\_exclude\_root | string | false | `"false"` | Exclude the root directory represented<br> by `.` from the output<br>when `dir_names`is set to `true`. |
| dir\_names\_max\_depth | string | false | | Maximum depth of directories to<br> output. e.g `test/test1/test2` with max<br>depth of `2` returns `test/test1`. |
| fetch\_depth | string | false | `"50"` | Depth of additional branch history<br> fetched. **NOTE**: This can be<br> adjusted to resolve errors with<br>insufficient history. |
| files | string | false | | File and directory patterns to<br> detect changes using only these<br> list of file(s) (Defaults to<br> the entire repo) **NOTE:** Multiline<br> file/directory patterns should not include<br>quotes. |
| files\_from\_source\_file | string | false | | Source file(s) used to populate<br>the `files` input. |
| files\_ignore | string | false | | Ignore changes to these file(s)<br> **NOTE:** Multiline file/directory patterns should<br>not include quotes. |
| files\_ignore\_from\_source\_file | string | false | | Source file(s) used to populate<br>the `files_ignore` input |
| files\_ignore\_separator | string | false | `"\n"` | Separator used to split the<br>`files_ignore` input |
| files\_separator | string | false | `"\n"` | Separator used to split the<br>`files` input |
| include\_all\_old\_new\_renamed\_files | string | false | `"false"` | Include `all_old_new_renamed_files` output. Note this<br> can generate a large output<br>See: [#501](https://github.com/tj-actions/changed-files/issues/501). |
| json | string | false | `"false"` | Output list of changed files<br> in a JSON formatted string<br> which can be used for<br>matrix jobs. |
| json\_raw\_format | string | false | `"false"` | Output list of changed files<br> in [jq](https://devdocs.io/jq/) raw output format which means that the output<br> will not be surrounded by<br> quotes and special characters will<br>not be escaped. |
| match\_directories | string | false | `"true"` | Indicates whether to include match<br>directories |
| old\_new\_files\_separator | string | false | `" "` | Split character for old and<br>new renamed filename pairs. |
| old\_new\_separator | string | false | `","` | Split character for old and<br>new filename pairs. |
| output\_dir | string | false | `".github/outputs"` | Directory to store output files. |
| path | string | false | `"."` | Specify a relative path under<br>`$GITHUB_WORKSPACE` to locate the repository. |
| quotepath | string | false | `"true"` | Use non ascii characters to<br> match files and output the<br> filenames completely verbatim by setting<br>this to `false` |
| separator | string | false | `" "` | Split character for output strings |
| sha | string | false | | Specify a different commit SHA<br>used for comparing changes |
| since | string | false | | Get changed files for commits<br> whose timestamp is older than<br>the given time. |
| since\_last\_remote\_commit | string | false | `"false"` | Use the last commit on<br> the remote branch as the<br> `base_sha`. Defaults to the last<br> non merge commit on the<br> target branch for pull request<br> events and the previous remote<br> commit of the current branch<br>for push events. |
| until | string | false | | Get changed files for commits<br> whose timestamp is earlier than<br>the given time. |
| write\_output\_files | string | false | `"false"` | Write outputs to files in<br>the `.github/outputs` folder by default. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------------------------------|--------|----------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| base\_sha | string | false | | Specify a different base commit <br>SHA used for comparing changes |
| diff\_relative | string | false | | Exclude changes outside the current <br>directory and show path names <br>relative to it. **NOTE:** This <br>requires you to specify the <br>top level directory via the <br>`path` input. |
| dir\_names | string | false | `"false"` | Output unique changed directories instead <br>of filenames. **NOTE:** This returns <br>`.` for changed files located <br>in the root of the <br>project. |
| dir\_names\_exclude\_root | string | false | `"false"` | Exclude the root directory represented <br>by `.` from the output <br>when `dir_names`is set to `true`. |
| dir\_names\_max\_depth | string | false | | Maximum depth of directories to <br>output. e.g `test/test1/test2` with max <br>depth of `2` returns `test/test1`. |
| fetch\_depth | string | false | `"50"` | Depth of additional branch history <br>fetched. **NOTE**: This can be <br>adjusted to resolve errors with <br>insufficient history. |
| files | string | false | | File and directory patterns to <br>detect changes using only these <br>list of file(s) (Defaults to the entire repo) **NOTE:** <br>Multiline file/directory patterns should not <br>include quotes. |
| files\_from\_source\_file | string | false | | Source file(s) used to populate <br>the `files` input. |
| files\_ignore | string | false | | Ignore changes to these file(s) <br>**NOTE:** Multiline file/directory patterns should <br>not include quotes. |
| files\_ignore\_from\_source\_file | string | false | | Source file(s) used to populate <br>the `files_ignore` input |
| files\_ignore\_separator | string | false | `"\n"` | Separator used to split the <br>`files_ignore` input |
| files\_separator | string | false | `"\n"` | Separator used to split the <br>`files` input |
| include\_all\_old\_new\_renamed\_files | string | false | `"false"` | Include `all_old_new_renamed_files` output. Note this <br>can generate a large output <br>See: [#501](https://github.com/tj-actions/changed-files/issues/501). |
| json | string | false | `"false"` | Output list of changed files <br>in a JSON formatted string <br>which can be used for <br>matrix jobs. |
| json\_raw\_format | string | false | `"false"` | Output list of changed files <br>in [jq](https://devdocs.io/jq/) raw output format <br>which means that the output <br>will not be surrounded by <br>quotes and special characters will <br>not be escaped. |
| match\_directories | string | false | `"true"` | Indicates whether to include match <br>directories |
| old\_new\_files\_separator | string | false | `" "` | Split character for old and <br>new renamed filename pairs. |
| old\_new\_separator | string | false | `","` | Split character for old and <br>new filename pairs. |
| output\_dir | string | false | `".github/outputs"` | Directory to store output files. |
| path | string | false | `"."` | Specify a relative path under <br>`$GITHUB_WORKSPACE` to locate the repository. |
| quotepath | string | false | `"true"` | Use non ascii characters to <br>match files and output the <br>filenames completely verbatim by setting <br>this to `false` |
| separator | string | false | `" "` | Split character for output strings |
| sha | string | false | | Specify a different commit SHA <br>used for comparing changes |
| since | string | false | | Get changed files for commits <br>whose timestamp is older than <br>the given time. |
| since\_last\_remote\_commit | string | false | `"false"` | Use the last commit on <br>the remote branch as the <br>`base_sha`. Defaults to the last <br>non merge commit on the <br>target branch for pull request <br>events and the previous remote <br>commit of the current branch <br>for push events. |
| until | string | false | | Get changed files for commits <br>whose timestamp is earlier than <br>the given time. |
| write\_output\_files | string | false | `"false"` | Write outputs to files in <br>the `.github/outputs` folder by default. |
<!-- AUTO-DOC-INPUT:END -->