actions/changed-files
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: updated docs

Browse Source
This commit is contained in:
Tonye Jack
2022-10-29 15:48:36 -06:00
parent bb9c177485
commit 335f001567
4 changed files with 109 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
README.md
View File

@@ -102,7 +102,7 @@ Support this project with a :star:
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
## Outputs
## Useful Acronyms
| Acronym | Meaning |
|:---------:|:------------:|
@@ -115,54 +115,64 @@ Support this project with a :star:
| U | Unmerged |
| X | Unknown |
| 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. 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. <br /> i.e. *using a combination of all added, <br />copied, modified and renamed files (ACMR)* |
| other\_changed\_files | `string` | `'new.txt path/to/file.png ...'` | Returns all other changed files <br/> not listed in the files input <br /> i.e. *using a combination of all added, <br />copied, modified and renamed files (ACMR)* |
| 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) |
| other\_modified\_files | `string` | `'new.txt path/to/file.png ...'` | Returns 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)* |
| 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) |
| other\_deleted\_files | `string` | `'new.txt path/to/file.png ...'` | Returns 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 ...'` | Returns 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 ...'` | Returns 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 ...'` | Returns all changed <br /> and modified files <br /> i.e. *a combination of (ACMRDTUX)* |
| all\_old\_new\_renamed\_files | `string` | `'old name.txt,new name.txt old name 2.txt,new name 2.txt...'` | Returns 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) |
| added\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that are Added (A) |
| copied\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that are Copied (C) |
| deleted\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that are Deleted (D) |
| modified\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that are Modified (M) |
| renamed\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that are Renamed (R) |
| type\_changed\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that have their file type changed (T) |
| unmerged\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that are Unmerged (U) |
| unknown\_files | `string` | `'new.txt path/to/file.png ...'` | Returns only files that are Unknown (X) |
## Outputs
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
| OUTPUT | TYPE | DESCRIPTION |
|--------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| added_files | string | Returns only files that are Added (A). |
| all_changed_and_modified_files | string | Returns all changed and modified files i.e. *a combination of (ACMRDTUX)* |
| all_changed_files | string | Returns all changed files i.e. *a combination of all added, copied, modified<br>and renamed files (ACMR)* |
| all_modified_files | string | Returns all changed files i.e. *a combination of all added, copied, modified,<br>renamed and deleted files (ACMRD)*. |
| all_old_new_renamed_files | string | Returns only files that are Renamed and list their old and new<br>names. **NOTE:** This requires setting `include_all_old_new_renamed_files` to `true` (R) |
| any_changed | string | Returns `true` when any of the filenames provided using the `files` input<br>has changed. If no `files` have been specified,an empty string `''` is<br>returned. i.e. *using a combination of all added, copied, modified and renamed<br>files (ACMR)*. |
| any_deleted | string | Returns `true` when any of the filenames provided using the `files` input<br>has been deleted. If no `files` have been specified,an empty string `''`<br>is returned. (D) |
| any_modified | string | Returns `true` when any of the filenames provided using the `files` input<br>has been modified. If no `files` have been specified,an empty string `''`<br>is returned. i.e. *using a combination of all added, copied, modified, renamed,<br>and deleted files (ACMRD)*. |
| copied_files | string | Returns only files that are Copied (C). |
| deleted_files | string | Returns only files that are Deleted (D). |
| modified_files | string | Returns only files that are Modified (M). |
| only_changed | string | Returns `true` when only files provided using the `files` input has changed.<br>If no `files` have been specified,an empty string `''` is returned. i.e.<br>*using a combination of all added, copied, modified and renamed files (ACMR)*.<br> |
| only_deleted | string | Returns `true` when only files provided using the `files` input has been<br>deleted. If no `files` have been specified,an empty string `''` is returned.<br>(D) |
| only_modified | string | Returns `true` when only files provided using the `files` input has been<br>modified. If no `files` have been specified,an empty string `''` is returned.(ACMRD).<br> |
| other_changed_files | string | Returns all other changed files not listed in the files input i.e.<br>*using a combination of all added, copied, modified and renamed files (ACMR)*.<br> |
| other_deleted_files | string | Returns all other deleted files not listed in the files input i.e.<br>*a combination of all deleted files (D)* |
| other_modified_files | string | Returns all other modified files not listed in the files input i.e.<br>*a combination of all added, copied, modified, and deleted files (ACMRD)* |
| renamed_files | string | Returns only files that are Renamed (R). |
| type_changed_files | string | Returns only files that have their file type changed (T). |
| unknown_files | string | Returns only files that are Unknown (X). |
| unmerged_files | string | Returns only files that are Unmerged (U). |
<!-- AUTO-DOC-OUTPUT:END -->
## Inputs
| Input | type | required | default | description |
|:--------------------------------------:|:----------------------:|:--------:|:-------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| separator | `string` | `false` | `' '` | Split character for output strings |
| 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). |
| 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) <br /> **NOTE:** Multiline file/directory patterns <br /> should not include qoutes. <br /> |
| 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) <br /> **NOTE:** Multiline file/directory patterns <br /> should not include qoutes. <br /> |
| 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 |
| 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. **NOTE:** This requires you to specify the top level directory via the `path` input. |
| 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](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/manual-matrix-test.yml). |
| since | `string` | `false` | | Get changed files for commits whose timestamp is older than the given time. |
| until | `string` | `false` | | Get changed files for commits whose timestamp is earlier than the given time. |
| max\_fetch\_depth | `string` | `false` | `120` | Max limit for fetching branch history. **NOTE**: This can be adjusted to resolve errors with insufficient history. |
<!-- 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 SHA used for comparing changes |
| diff_relative | string | false | | Exclude changes outside the current directory and show pathnames relative to it.<br>**NOTE:** This requires you to specify the top level directory via the<br>`path` input. |
| dir_names | string | false | `"false"` | Output unique changed directories instead of filenames. **NOTE:** This returns `.` for<br>changed files located in the root of the project. |
| files | string | false | | File and directory patterns to detect changes using only these list of<br>file(s) (Defaults to the entire repo) **NOTE:** Multiline file/directory patterns should not<br>include qoutes. |
| files_from_source_file | string | false | | Source file(s) used to populate the `files` input. |
| files_ignore | string | false | | Ignore changes to these file(s) **NOTE:** Multiline file/directory patterns should not include<br>qoutes. |
| files_ignore_from_source_file | string | false | | Source file(s) used to populate the `files_ignore` input |
| files_ignore_separator | string | false | `"\n"` | Separator used to split the `files-ignore` input |
| files_separator | string | false | `"\n"` | Separator used to split the `files` input |
| include_all_old_new_renamed_files | string | 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).<br> |
| json | string | false | `"false"` | Output list of changed files in a JSON formatted string which can<br>be used for matrix jobs. |
| max_fetch_depth | string | false | `"120"` | Max limit for fetching branch history. **NOTE**: This can be adjusted to<br>resolve errors with insufficient history. |
| old_new_files_separator | string | false | `" "` | Split character for multiple old and new filename pairs. |
| old_new_separator | string | false | `","` | Split character for old and new filename pairs. |
| path | string | false | `"."` | Specify a relative path under `$GITHUB_WORKSPACE` to locate the repository. |
| quotepath | string | false | `"true"` | Use non ascii characters to match files and output the filenames completely<br>verbatim by setting this to `false` |
| separator | string | false | `" "` | Split character for output strings |
| sha | string | true | `"${{ github.sha }}"` | Specify a different commit SHA used for comparing changes |
| since | string | false | | Get changed files for commits whose timestamp is older than the given<br>time. |
| until | string | false | | Get changed files for commits whose timestamp is earlier than the given<br>time. |
<!-- AUTO-DOC-INPUT:END -->
## Examples