From 1b8d7e81b05bec74d90efefaf07c8824304aaef7 Mon Sep 17 00:00:00 2001 From: jackton1 Date: Sat, 29 Oct 2022 21:54:35 +0000 Subject: [PATCH] Updated README.md --- README.md | 66 +++++++++++++++++++++++++++---------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index a05fbece..4c287f4c 100644 --- a/README.md +++ b/README.md @@ -121,27 +121,27 @@ Support this project with a :star: | 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
and renamed files (ACMR)* | -| all_modified_files | string | Returns all changed files i.e. *a combination of all added, copied, modified,
renamed and deleted files (ACMRD)*. | -| all_old_new_renamed_files | string | Returns only files that are Renamed and list their old and new
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
has changed. If no `files` have been specified,an empty string `''` is
returned. i.e. *using a combination of all added, copied, modified and renamed
files (ACMR)*. | -| any_deleted | string | Returns `true` when any of the filenames provided using the `files` input
has been deleted. If no `files` have been specified,an empty string `''`
is returned. (D) | -| any_modified | string | Returns `true` when any of the filenames provided using the `files` input
has been modified. If no `files` have been specified,an empty string `''`
is returned. i.e. *using a combination of all added, copied, modified, renamed,
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.
If no `files` have been specified,an empty string `''` is returned. i.e.
*using a combination of all added, copied, modified and renamed files (ACMR)*.
| -| only_deleted | string | Returns `true` when only files provided using the `files` input has been
deleted. If no `files` have been specified,an empty string `''` is returned.
(D) | -| only_modified | string | Returns `true` when only files provided using the `files` input has been
modified. If no `files` have been specified,an empty string `''` is returned.(ACMRD).
| -| other_changed_files | string | Returns all other changed files not listed in the files input i.e.
*using a combination of all added, copied, modified and renamed files (ACMR)*.
| -| other_deleted_files | string | Returns all other deleted files not listed in the files input i.e.
*a combination of all deleted files (D)* | -| other_modified_files | string | Returns all other modified files not listed in the files input i.e.
*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). | +| 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
and renamed files (ACMR)* | +| all\_modified\_files | string | Returns all changed files i.e. *a combination of all added, copied, modified,
renamed and deleted files (ACMRD)*. | +| all\_old\_new\_renamed\_files | string | Returns only files that are Renamed and list their old and new
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
has changed. If no `files` have been specified,an empty string `''` is
returned. i.e. *using a combination of all added, copied, modified and renamed
files (ACMR)*. | +| any\_deleted | string | Returns `true` when any of the filenames provided using the `files` input
has been deleted. If no `files` have been specified,an empty string `''`
is returned. (D) | +| any\_modified | string | Returns `true` when any of the filenames provided using the `files` input
has been modified. If no `files` have been specified,an empty string `''`
is returned. i.e. *using a combination of all added, copied, modified, renamed,
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.
If no `files` have been specified,an empty string `''` is returned. i.e.
*using a combination of all added, copied, modified and renamed files (ACMR)*.
| +| only\_deleted | string | Returns `true` when only files provided using the `files` input has been
deleted. If no `files` have been specified,an empty string `''` is returned.
(D) | +| only\_modified | string | Returns `true` when only files provided using the `files` input has been
modified. If no `files` have been specified,an empty string `''` is returned.(ACMRD).
| +| other\_changed\_files | string | Returns all other changed files not listed in the files input i.e.
*using a combination of all added, copied, modified and renamed files (ACMR)*.
| +| other\_deleted\_files | string | Returns all other deleted files not listed in the files input i.e.
*a combination of all deleted files (D)* | +| other\_modified\_files | string | Returns all other modified files not listed in the files input i.e.
*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). | @@ -151,20 +151,20 @@ Support this project with a :star: | 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.
**NOTE:** This requires you to specify the top level directory via the
`path` input. | -| dir_names | string | false | `"false"` | Output unique changed directories instead of filenames. **NOTE:** This returns `.` for
changed files located in the root of the project. | +| 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.
**NOTE:** This requires you to specify the top level directory via the
`path` input. | +| dir\_names | string | false | `"false"` | Output unique changed directories instead of filenames. **NOTE:** This returns `.` for
changed files located in the root of the project. | | files | string | false | | File and directory patterns to detect changes using only these list of
file(s) (Defaults to the entire repo) **NOTE:** Multiline file/directory patterns should not
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
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).
| +| 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
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).
| | json | string | false | `"false"` | Output list of changed files in a JSON formatted string which can
be used for matrix jobs. | -| max_fetch_depth | string | false | `"120"` | Max limit for fetching branch history. **NOTE**: This can be adjusted to
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. | +| max\_fetch\_depth | string | false | `"120"` | Max limit for fetching branch history. **NOTE**: This can be adjusted to
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
verbatim by setting this to `false` | | separator | string | false | `" "` | Split character for output strings |